@aws-amplify/api

constructor

constructor(options: any);

• Initialize API with AWS configuration

  Parameter options

  Configuration object for API

property Auth

Auth: any;

property Cache

Cache: any;

property Credentials

Credentials: any;

method cancel

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

• Cancels an inflight request for either a GraphQL request or a Rest API request.

  Parameter request

  request to cancel

  Parameter message

  custom error message If the request was cancelled

method configure

configure: (options: any) => any;

• Configure API part with aws configurations

  Parameter config

  Configuration of the API {Object} - The current configuration

method del

del: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a DEL request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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

method endpoint

endpoint: (apiName: string) => Promise<string>;

• Getting endpoint for API

  Parameter apiName

  The name of the api The endpoint of the api

method get

get: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a GET request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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

method getGraphqlOperationType

getGraphqlOperationType: (operation: GraphQLOperation) => OperationTypeNode;

• to get the operation type

  Parameter operation

method getModuleName

getModuleName: () => string;

method graphql

graphql: <T>(
    options: GraphQLOptions,
    additionalHeaders?: { [key: string]: string }
) => T extends GraphQLQuery<T>
    ? Promise<GraphQLResult<T>>
    : T extends GraphQLSubscription<T>
    ? Observable<{
          provider: AWSAppSyncRealTimeProvider;
          value: GraphQLResult<T>;
      }>
    : Promise<GraphQLResult<any>> | Observable<object>;

• Executes a GraphQL operation

  Parameter options

  GraphQL Options

  Parameter additionalHeaders

  headers to merge in after any graphql_headers set in the config

  Returns

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

method head

head: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a HEAD request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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

method isCancel

isCancel: (error: any) => boolean;

• Checks to see if an error thrown is from an api request cancellation

  Parameter error

  Any error If the error was from an api request cancellation

method patch

patch: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a PATCH request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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

method post

post: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a POST request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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

method put

put: (
    apiName: string,
    path: string,
    init: { [key: string]: any }
) => Promise<any>;

• Make a PUT request

  Parameter apiName

  The api name of the request

  Parameter path

  The path of the request

  Parameter init

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