RestAPIClass | amplify-js

Export Cloud Logic APIs

Hierarchy

RestAPIClass

Index

Constructors

constructor

Properties

Credentials

Methods

Constructors

constructor

new RestAPIClass(options: any): RestAPIClass

- Defined in packages/api-rest/src/RestAPI.ts:23
Initialize Rest API with AWS configuration

Parameters
- options: any
  
  Configuration object for API
Returns RestAPIClass

Properties

Credentials

Credentials: CredentialsClass = Credentials

Methods

cancel

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

- Defined in packages/api-rest/src/RestAPI.ts:270
Cancels an inflight request

Parameters
- request: Promise<any>
  
  request to cancel
- Optional message: string
Returns boolean
- A boolean indicating if the request was cancelled

configure

configure(options: any): any

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

Parameters
- options: any
Returns any
- The current configuration

createInstance

createInstance(): boolean

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

Returns boolean
- A promise of true if Success

del

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

- Defined in packages/api-rest/src/RestAPI.ts:211
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<string>

- Defined in packages/api-rest/src/RestAPI.ts:288
Getting endpoint for API

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

get

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

- Defined in packages/api-rest/src/RestAPI.ts:107
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.

getModuleName

getModuleName(): string

- Defined in packages/api-rest/src/RestAPI.ts:34
Returns string

hasCancelToken

hasCancelToken(request: Promise<any>): boolean

- Defined in packages/api-rest/src/RestAPI.ts:279
Check if the request has a corresponding cancel token in the WeakMap.

params

request - The request promise

Parameters
- request: Promise<any>
Returns boolean

if the request has a corresponding cancel token.

head

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

- Defined in packages/api-rest/src/RestAPI.ts:237
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.

isCancel

isCancel(error: any): boolean

- Defined in packages/api-rest/src/RestAPI.ts:261
Checks to see if an error thrown is from an api request cancellation

Parameters
- error: any
  
  Any error
Returns boolean
- A boolean indicating if the error was from an api request cancellation

patch

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

- Defined in packages/api-rest/src/RestAPI.ts:185
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-rest/src/RestAPI.ts:133
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-rest/src/RestAPI.ts:159
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.