@sudoplatform/sudo-user
    Preparing search index...

    Interface GraphQLClient

    Interface for GraphQL client operations.

    interface GraphQLClient {
        mutate<T>(
            options: {
                idToken?: string;
                mutation: string | DocumentNode;
                variables?: any;
            },
        ): Promise<GraphQLResult<T>>;
        query<T>(
            options: {
                idToken?: string;
                query: string | DocumentNode;
                variables?: any;
            },
        ): Promise<GraphQLResult<T>>;
        subscribe<T>(
            options: {
                idToken?: string;
                subscription: string | DocumentNode;
                variables?: any;
            },
        ): Promise<Observable<GraphQLResult<T>>>;
    }

    Implemented by

    Index

    Methods

    mutate query subscribe

    Methods

    • Performs GraphQL mutation operation.

      Type Parameters

      • T

      Parameters

      • options: { idToken?: 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.

    • Performs GraphQL query operation.

      Type Parameters

      • T

      Parameters

      • options: { idToken?: 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.

    • Performs GraphQL subscription operation.

      Type Parameters

      • T

      Parameters

      • options: { idToken?: 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.

    Settings

    Member Visibility

    On This Page

    Methods