Skip to main content

Class: IotaGraphQLClient<Queries>

Type Parameters

Queries extends Record<string, GraphQLDocument> = object

Constructors

new IotaGraphQLClient()

new IotaGraphQLClient<Queries>(__namedParameters): IotaGraphQLClient<Queries>

Parameters

__namedParameters: IotaGraphQLClientOptions<Queries>

Returns

IotaGraphQLClient<Queries>

Methods

query()

query<Result, Variables>(options): Promise<GraphQLQueryResult<Result>>

Type Parameters

Result = Record<string, unknown>

Variables = Record<string, unknown>

Parameters

options: GraphQLQueryOptions<Result, Variables>

Returns

Promise<GraphQLQueryResult<Result>>


execute()

execute<Query, Result, Variables>(query, options): Promise<GraphQLQueryResult<Result>>

Type Parameters

Query extends string

Result = Queries[Query] extends GraphQLDocument<R, unknown> ? R : Record<string, unknown>

Variables = Queries[Query] extends GraphQLDocument<unknown, V> ? V : Record<string, unknown>

Parameters

query: Query

options: Omit<GraphQLQueryOptions<Result, Variables>, "query">

Returns

Promise<GraphQLQueryResult<Result>>