Class AppSyncClient

A tiny, fully-typed AWS AppSync GraphQL client.

import { AppSyncClient } from 'aws-appsync-js';

const client = new AppSyncClient({
  url: 'https://abc.appsync-api.us-east-1.amazonaws.com/graphql',
  auth: { type: 'apiKey', apiKey: 'da2-...' },
});

const { events } = await client.request<{ events: Event[] }>(`
  query { events { id name } }
`);

Constructors

constructor

Methods

request requestRaw query mutate introspect

Constructors

constructor

Methods

request

  • request<TData, TVariables extends Variables>(
        document: TypedDocumentNode<TData, TVariables>,
        variables: TVariables,
        options?: RequestOptions,
    ): Promise<TData>

    Send a GraphQL operation (query or mutation) to AppSync.

    Type Parameters

    Parameters

    Returns Promise<TData>

    The data payload, not the full response envelope. Pass { throwOnGraphQLError: false } if you need the raw response.

    Throws

    AppSyncGraphQLError when the server returns errors.

    Throws

    AppSyncHttpError on a non-2xx HTTP response.

    Throws

    AppSyncNetworkError when fetch itself rejects.

    Throws

    AppSyncAbortError when the request is aborted or times out.

    Example: Plain string query

    const data = await client.request<{ me: { id: string } }>(`query { me { id } }`);

    Example: TypedDocumentNode (full inference, zero hand-written types)

    import { GetUserDocument } from './generated/graphql';
    const data = await client.request(GetUserDocument, { id: '1' });
    //    ^? GetUserQuery
  • request<TData, TVariables extends Variables = Variables>(
        document: TypedDocumentNode<TData, TVariables>,
        variables?: TVariables,
        options?: RequestOptions,
    ): Promise<TData>

    Send a GraphQL operation (query or mutation) to AppSync.

    Type Parameters

    Parameters

    Returns Promise<TData>

    The data payload, not the full response envelope. Pass { throwOnGraphQLError: false } if you need the raw response.

    Throws

    AppSyncGraphQLError when the server returns errors.

    Throws

    AppSyncHttpError on a non-2xx HTTP response.

    Throws

    AppSyncNetworkError when fetch itself rejects.

    Throws

    AppSyncAbortError when the request is aborted or times out.

    Example: Plain string query

    const data = await client.request<{ me: { id: string } }>(`query { me { id } }`);

    Example: TypedDocumentNode (full inference, zero hand-written types)

    import { GetUserDocument } from './generated/graphql';
    const data = await client.request(GetUserDocument, { id: '1' });
    //    ^? GetUserQuery
  • request<TData = unknown, TVariables extends Variables = Variables>(
        document: string | DocumentNode,
        variables?: TVariables,
        options?: RequestOptions,
    ): Promise<TData>

    Send a GraphQL operation (query or mutation) to AppSync.

    Type Parameters

    Parameters

    Returns Promise<TData>

    The data payload, not the full response envelope. Pass { throwOnGraphQLError: false } if you need the raw response.

    Throws

    AppSyncGraphQLError when the server returns errors.

    Throws

    AppSyncHttpError on a non-2xx HTTP response.

    Throws

    AppSyncNetworkError when fetch itself rejects.

    Throws

    AppSyncAbortError when the request is aborted or times out.

    Example: Plain string query

    const data = await client.request<{ me: { id: string } }>(`query { me { id } }`);

    Example: TypedDocumentNode (full inference, zero hand-written types)

    import { GetUserDocument } from './generated/graphql';
    const data = await client.request(GetUserDocument, { id: '1' });
    //    ^? GetUserQuery

requestRaw

query

mutate

introspect

Settings

Member Visibility

On This Page

Constructors
Methods