GraphqlClient

Defined in: graphql-client/src/GraphqlClient.ts:12

Graphql Client class provides functionality specific to GraphQL servers.

See

• ApiClientOptions
• BaseUrl

Extends

• ApiClient

Constructors

Constructor

new GraphqlClient(baseUrl, options?): GraphqlClient;

Defined in: graphql-client/src/GraphqlClient.ts:18

Creates a new instance of the GraphqlClient.

Parameters

baseUrl

string

The base URL of the API. BaseUrl

options?

ApiClientOptions

(Optional) Additional options for configuring the API client. ApiClientOptions

Returns

GraphqlClient

Overrides

ApiClient.constructor

Properties

apiPrefix

apiPrefix: string | undefined;

Defined in: api-client/dist/index.d.mts:216

ApiClientOptions.apiPrefix

Inherited from

ApiClient.apiPrefix

---

authentication

authentication: Authentication | undefined;

Defined in: api-client/dist/index.d.mts:224

ApiClientOptions.authentication

Inherited from

ApiClient.authentication

---

baseUrl

baseUrl: string;

Defined in: api-client/dist/index.d.mts:212

BaseUrl

Inherited from

ApiClient.baseUrl

---

cache

cache: Cache | undefined;

Defined in: api-client/dist/index.d.mts:232

ApiClientOptions.cache

Inherited from

ApiClient.cache

---

customFetch

customFetch:
  | ((input, init?) => Promise<Response>)
  | undefined;

Defined in: api-client/dist/index.d.mts:220

ApiClientOptions.customFetch

Inherited from

ApiClient.customFetch

---

debug

debug: boolean | undefined;

Defined in: api-client/dist/index.d.mts:244

ApiClientOptions.debug

Inherited from

ApiClient.debug

---

defaultLocale

defaultLocale: string | undefined;

Defined in: api-client/dist/index.d.mts:228

ApiClientOptions.defaultLocale

Inherited from

ApiClient.defaultLocale

---

logger

logger:
  | {
  debug?: LogMethod;
  error?: LogMethod;
  http?: LogMethod;
  info?: LogMethod;
  silly?: LogMethod;
  verbose?: LogMethod;
  warn?: LogMethod;
}
  | undefined;

Defined in: api-client/dist/index.d.mts:240

ApiClientOptions.logger

Inherited from

ApiClient.logger

---

serializer

serializer: Serializer | undefined;

Defined in: api-client/dist/index.d.mts:236

ApiClientOptions.serializer

Inherited from

ApiClient.serializer

Methods

addAuthorizationHeader()

addAuthorizationHeader(options): Promise<RequestInit>;

Defined in: api-client/dist/index.d.mts:274

Adds an authorization header to the provided RequestInit options if authentication of type “Basic” is configured. If the authentication type is “OAuth”, it will fetch a new access token or use the stored access token if it exists and is still valid. if the authentication type is “Custom”, it will use the provided value.

Parameters

options

RequestInit | undefined

The RequestInit options to which the authorization header should be added.

Returns

Promise<RequestInit>

The updated RequestInit options with the authorization header, if applicable.

Inherited from

ApiClient.addAuthorizationHeader

---

fetch()

fetch(input, init?): Promise<FetchReturn>;

Defined in: api-client/dist/index.d.mts:257

Uses customFetch if it is set, otherwise uses the default fetch

Parameters

input

RequestInfo | URL

RequestInfo

init?

RequestInit

RequestInit

Returns

Promise<FetchReturn>

a response wrapped in a promise

Inherited from

ApiClient.fetch

---

getAccessToken()

protected getAccessToken(__namedParameters): Promise<OAuthTokenResponse>;

Defined in: api-client/dist/index.d.mts:262

Fetch the OAuth token from the BaseUrl

Parameters

__namedParameters

OAuthCredentials

Returns

Promise<OAuthTokenResponse>

Params

params - The credentials for getting an OAuth token. OAuthCredentials

Inherited from

ApiClient.getAccessToken

---

getCachedResponse()

getCachedResponse<T>(cacheKey): Promise<
  | NonNullable<Awaited<T>>
| null>;

Defined in: api-client/dist/index.d.mts:286

Retrieves a cached response from the cache.

Type Parameters

T

T

Parameters

cacheKey

string

The cache key to use for retrieving the cached response.

Returns

Promise< | NonNullable<Awaited<T>> | null>

A promise wrapping the cached response as a generic type.

Inherited from

ApiClient.getCachedResponse

---

log()

log(level, message): void;

Defined in: api-client/dist/index.d.mts:280

Calls the appropriate logger method based on level

Parameters

level

LogLevels

level based on npm log levels

message

string

the message to log

Returns

void

Inherited from

ApiClient.log

---

query()

query<T>(query): Promise<T>;

Defined in: graphql-client/src/GraphqlClient.ts:42

Retrieves data of a specific shape from GraphQL.

Type Parameters

T

T

Parameters

query

string

a string containing the desired GraphQL Query.

Returns

Promise<T>

A Promise that resolves to the requested JSON data.

Example

const query = await graphqlClient.query(
`query GetArticles {
  nodeArticles(first: 10) {
    nodes {
      title
    }
  }
}`,
);