Interface ProviderGraphQLLibrary

interface ProviderGraphQLLibrary {
    rawToEnvelope(
        config: MagekConfig,
        rawGraphQLRequest: unknown,
    ): Promise<GraphQLRequestEnvelope | GraphQLRequestEnvelopeError>;
    handleResult(
        result?: unknown,
        headers?: Record<string, string>,
    ): Promise<unknown>;
}

Index

Methods

rawToEnvelope handleResult

Methods

rawToEnvelope

rawToEnvelope(
config: MagekConfig,
rawGraphQLRequest: unknown,
): Promise<GraphQLRequestEnvelope | GraphQLRequestEnvelopeError>
Converts a raw GraphQL request to a GraphQLRequestEnvelope or a GraphQLRequestEnvelopeError.
Parameters
- config: MagekConfig
  The Magek configuration object.
- rawGraphQLRequest: unknown
  The raw GraphQL request to be converted.
Returns Promise<GraphQLRequestEnvelope | GraphQLRequestEnvelopeError>
A promise that resolves to either a GraphQLRequestEnvelope or a GraphQLRequestEnvelopeError object.
- Defined in packages/common/src/provider.ts:49

handleResult

handleResult(
result?: unknown,
headers?: Record<string, string>,
): Promise<unknown>
Handles the result of a GraphQL request.
Parameters
- Optionalresult: unknown
  The result of the GraphQL request (optional).
- Optionalheaders: Record<string, string>
  The headers associated with the GraphQL request result (optional).
Returns Promise<unknown>
A promise that resolves to any value.
- Defined in packages/common/src/provider.ts:61

Interface ProviderGraphQLLibrary

Index

Methods

Methods

rawToEnvelope

Parameters

Returns Promise<GraphQLRequestEnvelope | GraphQLRequestEnvelopeError>

handleResult

Parameters

Returns Promise<unknown>

Settings

On This Page