Class AmplifyClient

Convenience wrapper for GraphQL API using Amplify SDK.

Implements

GraphQLClient

Index

Constructors

Methods

mutate query subscribe

Constructors

constructor

new AmplifyClient(options: GraphQLClientOptions): AmplifyClient
Parameters
- options: GraphQLClientOptions
Returns AmplifyClient
- Defined in src/client/amplifyClient.ts:71

Methods

mutate

mutate<T>(
    options: {
        authToken?: string;
        mutation: string | DocumentNode;
        variables?: any;
    },
): Promise<GraphQLResult<T>>
Performs GraphQL mutation operation.
Type Parameters
- T
Parameters
- options: { authToken?: string; mutation: string | DocumentNode; variables?: any }
  mutation document, mutation variables and authentication token (optional). If authentication token is provided then the token provided via the constructor will be ignored.
Returns Promise<GraphQLResult<T>>
mutation result.
Implementation of GraphQLClient.mutate
- Defined in src/client/amplifyClient.ts:183

query

query<T>(
    options: {
        authToken?: string;
        query: string | DocumentNode;
        variables?: any;
    },
): Promise<GraphQLResult<T>>
Performs GraphQL query operation.
Type Parameters
- T
Parameters
- options: { authToken?: string; query: string | DocumentNode; variables?: any }
  query document, query variables and authentication token (optional). If authentication token is provided then the token provided via the constructor will be ignored.
Returns Promise<GraphQLResult<T>>
query result.
Implementation of GraphQLClient.query
- Defined in src/client/amplifyClient.ts:158

subscribe<T>(
    options: {
        authToken?: string;
        subscription: string | DocumentNode;
        variables?: any;
    },
): Promise<Observable<GraphQLResult<T>>>
Performs GraphQL subscription operation.
Type Parameters
- T
Parameters
- options: { authToken?: string; subscription: string | DocumentNode; variables?: any }
  subscription document, subscription variables and authentication token (optional). If authentication token is provided then the token provided via the constructor will be ignored.
Returns Promise<Observable<GraphQLResult<T>>>
observable for receiving subscription notifications.
Implementation of GraphQLClient.subscribe
- Defined in src/client/amplifyClient.ts:209