GraphQLAPIClass | amplify-js

Export Cloud Logic APIs

Hierarchy

InternalGraphQLAPIClass
- GraphQLAPIClass

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new GraphQLAPIClass(options: any): GraphQLAPIClass

Inherited from InternalGraphQLAPIClass.constructor
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:56
Initialize GraphQL API with AWS configuration

Parameters
- options: any
  
  Configuration object for API
Returns GraphQLAPIClass

Properties

Auth

Auth: AuthClass = Auth

Cache

Cache: ICache = Cache

Credentials

Credentials: CredentialsClass = Credentials

Methods

cancel

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

Inherited from InternalGraphQLAPIClass.cancel
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:373
Cancels an inflight request. Only applicable for graphql queries and mutations

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

configure

configure(options: any): any

Inherited from InternalGraphQLAPIClass.configure
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:76
Configure API

Parameters
- options: any
Returns any
- The current configuration

createInstance

createInstance(): true | Promise<never>

Inherited from InternalGraphQLAPIClass.createInstance
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:107
Create an instance of API for the library

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

createInstanceIfNotCreated

createInstanceIfNotCreated(): Promise<void>

Inherited from InternalGraphQLAPIClass.createInstanceIfNotCreated
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:353
Returns Promise<void>

getGraphqlOperationType

getGraphqlOperationType(operation: GraphQLOperation): OperationTypeNode

Inherited from InternalGraphQLAPIClass.getGraphqlOperationType
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:201
to get the operation type

Parameters
- operation: GraphQLOperation
Returns OperationTypeNode

getModuleName

getModuleName(): string

Overrides InternalGraphQLAPIClass.getModuleName
- Defined in packages/api-graphql/src/GraphQLAPI.ts:22
Returns string

graphql

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

Overrides InternalGraphQLAPIClass.graphql
- Defined in packages/api-graphql/src/GraphQLAPI.ts:33
Executes a GraphQL operation

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

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

hasCancelToken

hasCancelToken(request: Promise<any>): any

Inherited from InternalGraphQLAPIClass.hasCancelToken
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:382
Check if the request has a corresponding cancel token in the WeakMap.

params

request - The request promise

Parameters
- request: Promise<any>
Returns any

if the request has a corresponding cancel token.

isCancel

isCancel(error: any): any

Inherited from InternalGraphQLAPIClass.isCancel
- Defined in packages/api-graphql/src/internals/InternalGraphQLAPI.ts:364
Checks to see if an error thrown is from an api request cancellation

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