APIClass | amplify-js

Export Cloud Logic APIs

Hierarchy

APIClass

Index

Constructors

constructor

Methods

Constructors

constructor

new APIClass(options: any): APIClass

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

Parameters
- options: any
  
  Configuration object for storage
Returns APIClass

Methods

Private _ensureCredentials

_ensureCredentials(): any

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

configure

configure(options: any): any

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

Parameters
- options: any
Returns any
- The current configuration

createInstance

createInstance(): any

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

Returns any
- A promise of true if Success

del

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

- Defined in api/src/API.ts:210
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 api/src/API.ts:254
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 api/src/API.ts:118
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 api/src/API.ts:315
to get the operation type

Parameters
- operation: any
Returns any

getModuleName

getModuleName(): string

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

graphql

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

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

Parameters
- __namedParameters: object
  - query: any
  - variables: any
Returns Promise<any> | Observable<object>

head

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

- Defined in api/src/API.ts:233
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 api/src/API.ts:187
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 api/src/API.ts:141
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 api/src/API.ts:164
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.