APIClass | amplify-js

deprecated: Use RestApi or GraphQLAPI to reduce your application bundle size Export Cloud Logic APIs

Hierarchy

InternalAPIClass
- APIClass

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new APIClass(options: any): APIClass

Inherited from InternalAPIClass.constructor
- Defined in packages/api/src/internals/InternalAPI.ts:42
Initialize API with AWS configuration

Parameters
- options: any
  
  Configuration object for API
Returns APIClass

Properties

Auth

Auth: AuthClass = Auth

Cache

Cache: ICache = Cache

Credentials

Credentials: CredentialsClass = Credentials

Methods

cancel

cancel(request: Promise<any>, message?: string): boolean

Inherited from InternalAPIClass.cancel
- Defined in packages/api/src/internals/InternalAPI.ts:208
Cancels an inflight request for either a GraphQL request or a Rest API request.

Parameters
- request: Promise<any>
  
  request to cancel
- Optional message: string
Returns boolean

If the request was cancelled

configure

configure(options: any): any

Inherited from InternalAPIClass.configure
- Defined in packages/api/src/internals/InternalAPI.ts:64
Configure API part with aws configurations

Parameters
- options: any
Returns any
- The current configuration

del

del(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.del
- Defined in packages/api/src/internals/InternalAPI.ts:163
Make a DEL request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

endpoint

endpoint(apiName: string): Promise<string>

Inherited from InternalAPIClass.endpoint
- Defined in packages/api/src/internals/InternalAPI.ts:234
Getting endpoint for API

Parameters
- apiName: string
  
  The name of the api
Returns Promise<string>

The endpoint of the api

get

get(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.get
- Defined in packages/api/src/internals/InternalAPI.ts:87
Make a GET request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

getGraphqlOperationType

getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode

Inherited from InternalAPIClass.getGraphqlOperationType
- Defined in packages/api/src/internals/InternalAPI.ts:242
to get the operation type

Parameters
- operation: GraphQLOperation
Returns OperationTypeNode

getModuleName

getModuleName(): string

Overrides InternalAPIClass.getModuleName
- Defined in packages/api/src/API.ts:17
Returns string

graphql

graphql<T>(options: GraphQLOptions, additionalHeaders?: object): T extends GraphQLQuery<T> ? Promise<GraphQLResult<T>> : T extends GraphQLSubscription<T> ? Observable<object> : Promise<GraphQLResult<any>> | Observable<object>

Overrides InternalAPIClass.graphql
- Defined in packages/api/src/API.ts:28
Executes a GraphQL operation

Type parameters
- T
Parameters
- options: GraphQLOptions
  
  GraphQL Options
- Optional additionalHeaders: object
  - [key: string]: string
Returns T extends GraphQLQuery<T> ? Promise<GraphQLResult<T>> : T extends GraphQLSubscription<T> ? Observable<object> : Promise<GraphQLResult<any>> | Observable<object>

An Observable if queryType is 'subscription', else a promise of the graphql result from the query.

head

head(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.head
- Defined in packages/api/src/internals/InternalAPI.ts:182
Make a HEAD request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

isCancel

isCancel(error: any): boolean

Inherited from InternalAPIClass.isCancel
- Defined in packages/api/src/internals/InternalAPI.ts:199
Checks to see if an error thrown is from an api request cancellation

Parameters
- error: any
  
  Any error
Returns boolean

If the error was from an api request cancellation

patch

patch(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.patch
- Defined in packages/api/src/internals/InternalAPI.ts:144
Make a PATCH request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

post

post(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.post
- Defined in packages/api/src/internals/InternalAPI.ts:106
Make a POST request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

put

put(apiName: string, path: string, init: object): Promise<any>

Inherited from InternalAPIClass.put
- Defined in packages/api/src/internals/InternalAPI.ts:125
Make a PUT request

Parameters
- apiName: string
  
  The api name of the request
- path: string
  
  The path of the request
- init: object
  - [key: string]: any
Returns Promise<any>

A promise that resolves to an object with response status and JSON data, if successful.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: any

Returns APIClass

Properties

Auth

Cache

Credentials

Methods

cancel

Parameters

request: Promise<any>

Optional message: string

Returns boolean

configure

Parameters

options: any

Returns any

del

Parameters

apiName: string

path: string

init: object

[key: string]: any

Returns Promise<any>

endpoint

Parameters

apiName: string

Returns Promise<string>

get

Parameters

apiName: string

path: string

init: object

[key: string]: any

Returns Promise<any>

getGraphqlOperationType

Parameters

operation: GraphQLOperation

Returns OperationTypeNode

getModuleName

Returns string

graphql

Type parameters

T

Parameters

options: GraphQLOptions

Optional additionalHeaders: object

[key: string]: string

Returns T extends GraphQLQuery<T> ? Promise<GraphQLResult<T>> : T extends GraphQLSubscription<T> ? Observable<object> : Promise<GraphQLResult<any>> | Observable<object>

head

Parameters

apiName: string

path: string

init: object

[key: string]: any

Returns Promise<any>

isCancel

Parameters

error: any

Returns boolean

patch

Parameters

apiName: string

path: string

init: object

[key: string]: any

Returns Promise<any>

post

Parameters

apiName: string

path: string

init: object

[key: string]: any