Skip to main content

IotaGraphQLClient

@iota/iota-sdk

@iota/iota-sdk / graphql / IotaGraphQLClient

Class: IotaGraphQLClient<Queries>

Defined in: sdk/typescript/src/graphql/client.ts:57

Type Parameters​

Queries​

Queries extends Record<string, GraphQLDocument> = { }

Constructors​

Constructor​

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

Defined in: sdk/typescript/src/graphql/client.ts:64

Parameters​

__namedParameters​

IotaGraphQLClientOptions<Queries>

Returns​

IotaGraphQLClient<Queries>

Methods​

execute()​

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

Defined in: sdk/typescript/src/graphql/client.ts:119

Type Parameters​

Query​

Query extends string

Result​

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

Variables​

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

Parameters​

query​

Query

options​

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

Returns​

Promise<GraphQLQueryResult<Result>>

query()​

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

Defined in: sdk/typescript/src/graphql/client.ts:78

Type Parameters​

Result​

Result = Record<string, unknown>

Variables​

Variables = Record<string, unknown>

Parameters​

options​

GraphQLQueryOptions<Result, Variables>

Returns​

Promise<GraphQLQueryResult<Result>>