Documentation
Preparing search index...
@mysten/sui
graphql
SuiGraphQLClient
Class SuiGraphQLClient<Queries>
Type Parameters
Queries
extends
Record
<
string
,
GraphQLDocument
>
=
{}
Hierarchy
Experimental_BaseClient
SuiGraphQLClient
Index
Constructors
constructor
Properties
base
cache
core
network
Methods
$extend
execute
query
Constructors
constructor
new
SuiGraphQLClient
<
Queries
extends
Record
<
string
,
GraphQLDocument
<
Record
<
string
,
unknown
>
,
Record
<
string
,
unknown
>
>
,
>
=
{}
,
>
(
__namedParameters
:
SuiGraphQLClientOptions
<
Queries
>
,
)
:
SuiGraphQLClient
<
Queries
>
Type Parameters
Queries
extends
Record
<
string
,
GraphQLDocument
<
Record
<
string
,
unknown
>
,
Record
<
string
,
unknown
>
>
,
>
=
{}
Parameters
__namedParameters
:
SuiGraphQLClientOptions
<
Queries
>
Returns
SuiGraphQLClient
<
Queries
>
Properties
base
base
:
Experimental_BaseClient
cache
cache
:
ClientCache
= ...
core
core
:
GraphQLTransport
network
network
:
Network
Methods
$extend
$extend
<
const
Registrations
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
>
[]
,
>
(
...
registrations
:
Registrations
,
)
:
ClientWithExtensions
<
{
[
K
in
string
|
number
|
symbol
]
:
UnionToIntersection
<
{
[
K
in
string
|
number
|
symbol
]
:
Registrations
[
K
<
K
>
]
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
,
Name
,
Extension
,
>
?
{
[
K2
in
string
]
:
Extension
}
:
never
}
[
number
]
,
>
[
K
]
}
,
SuiGraphQLClient
<
Queries
>
,
>
Type Parameters
const
Registrations
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
>
[]
Parameters
...
registrations
:
Registrations
Returns
ClientWithExtensions
<
{
[
K
in
string
|
number
|
symbol
]
:
UnionToIntersection
<
{
[
K
in
string
|
number
|
symbol
]
:
Registrations
[
K
<
K
>
]
extends
SuiClientRegistration
<
SuiGraphQLClient
<
Queries
>
,
Name
,
Extension
,
>
?
{
[
K2
in
string
]
:
Extension
}
:
never
}
[
number
]
,
>
[
K
]
}
,
SuiGraphQLClient
<
Queries
>
,
>
execute
execute
<
const
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
>
,
>
(
query
:
Query
,
options
:
Omit
<
GraphQLQueryOptions
<
Result
,
Variables
>
,
"query"
>
,
)
:
Promise
<
GraphQLQueryResult
<
Result
>
>
Type Parameters
const
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
>
>
query
query
<
Result
=
Record
<
string
,
unknown
>
,
Variables
=
Record
<
string
,
unknown
>
>
(
options
:
GraphQLQueryOptions
<
Result
,
Variables
>
,
)
:
Promise
<
GraphQLQueryResult
<
Result
>
>
Type Parameters
Result
=
Record
<
string
,
unknown
>
Variables
=
Record
<
string
,
unknown
>
Parameters
options
:
GraphQLQueryOptions
<
Result
,
Variables
>
Returns
Promise
<
GraphQLQueryResult
<
Result
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
base
cache
core
network
Methods
$extend
execute
query
Documentation
Loading...