APIClass | amplify-js

Export Cloud Logic APIs

Hierarchy

APIClass

Index

Constructors

constructor

Methods

Constructors

constructor

new APIClass(options: any): APIClass

- Defined in packages/api/src/API.ts:44
Initialize Storage with AWS configuration

Parameters
- options: any
  
  Configuration object for storage
Returns APIClass

Methods

Private _ensureCredentials

_ensureCredentials(): any

- Defined in packages/api/src/API.ts:488
Returns any

configure

configure(options: any): any

- Defined in packages/api/src/API.ts:64
Configure API part with aws configurations

Parameters
- options: any
Returns any
- The current configuration

createInstance

createInstance(): true | Promise<never>

- Defined in packages/api/src/API.ts:118
Create an instance of API for the library

Returns true | Promise<never>
- A promise of true if Success

del

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

- Defined in packages/api/src/API.ts:227
Make a DEL request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.

endpoint

endpoint(apiName: any): Promise<any>

- Defined in packages/api/src/API.ts:271
Getting endpoint for API

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

get

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

- Defined in packages/api/src/API.ts:135
Make a GET request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.

getGraphqlOperationType

getGraphqlOperationType(operation: any): any

- Defined in packages/api/src/API.ts:337
to get the operation type

Parameters
- operation: any
Returns any

getModuleName

getModuleName(): string

- Defined in packages/api/src/API.ts:55
Returns string

graphql

graphql(__namedParameters: object): Promise<GraphQLResult<object>> | Observable<any>

- Defined in packages/api/src/API.ts:352
Executes a GraphQL operation

Parameters
- __namedParameters: object
  - authMode: GRAPHQL_AUTH_MODE
  - paramQuery: any
  - variables: object
Returns Promise<GraphQLResult<object>> | Observable<any>

head

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

- Defined in packages/api/src/API.ts:250
Make a HEAD request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.

patch

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

- Defined in packages/api/src/API.ts:204
Make a PATCH request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.

post

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

- Defined in packages/api/src/API.ts:158
Make a POST request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.

put

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

- Defined in packages/api/src/API.ts:181
Make a PUT request

Parameters
- apiName: any
  
  The api name of the request
- path: any
  
  The path of the request
- init: any
Returns Promise<any>
- A promise that resolves to an object with response status and JSON data, if successful.