@@ -53,7 +53,7 @@ The SettleMint Hasura SDK provides a seamless way to interact with Hasura GraphQ
53
53
54
54
> ** createHasuraClient** \< ` Setup ` \> (` options ` , ` clientOptions? ` , ` logger? ` ): ` object `
55
55
56
- Defined in: [ sdk/hasura/src/hasura.ts:83] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L83 )
56
+ Defined in: [ sdk/hasura/src/hasura.ts:83] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L83 )
57
57
58
58
Creates a Hasura GraphQL client with proper type safety using gql.tada
59
59
@@ -85,8 +85,8 @@ An object containing:
85
85
86
86
| Name | Type | Defined in |
87
87
| ------ | ------ | ------ |
88
- | ` client ` | ` GraphQLClient ` | [ sdk/hasura/src/hasura.ts:88] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L88 ) |
89
- | ` graphql ` | ` initGraphQLTada ` \< ` Setup ` \> | [ sdk/hasura/src/hasura.ts:89] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L89 ) |
88
+ | ` client ` | ` GraphQLClient ` | [ sdk/hasura/src/hasura.ts:88] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L88 ) |
89
+ | ` graphql ` | ` initGraphQLTada ` \< ` Setup ` \> | [ sdk/hasura/src/hasura.ts:89] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L89 ) |
90
90
91
91
##### Throws
92
92
@@ -144,7 +144,7 @@ const result = await client.request(query);
144
144
145
145
> ** createHasuraMetadataClient** (` options ` , ` logger? ` ): \< ` T ` \> (` query ` ) => ` Promise ` \<\{ ` data ` : ` T ` ; ` ok ` : ` boolean ` ; \}\>
146
146
147
- Defined in: [ sdk/hasura/src/hasura.ts:132] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L132 )
147
+ Defined in: [ sdk/hasura/src/hasura.ts:132] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L132 )
148
148
149
149
Creates a Hasura Metadata client
150
150
@@ -210,7 +210,7 @@ const result = await client({
210
210
211
211
> ** createPostgresPool** (` databaseUrl ` ): ` Pool `
212
212
213
- Defined in: [ sdk/hasura/src/postgres.ts:107] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/postgres.ts#L107 )
213
+ Defined in: [ sdk/hasura/src/postgres.ts:107] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/postgres.ts#L107 )
214
214
215
215
Creates a PostgreSQL connection pool with error handling and retry mechanisms
216
216
@@ -253,7 +253,7 @@ try {
253
253
254
254
> ** trackAllTables** (` databaseName ` , ` client ` , ` tableOptions ` ): ` Promise ` \<\{ ` messages ` : ` string ` [ ] ; ` result ` : ` "success" ` \| ` "no-tables" ` ; \}\>
255
255
256
- Defined in: [ sdk/hasura/src/utils/track-all-tables.ts:30] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/utils/track-all-tables.ts#L30 )
256
+ Defined in: [ sdk/hasura/src/utils/track-all-tables.ts:30] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/utils/track-all-tables.ts#L30 )
257
257
258
258
Track all tables in a database
259
259
@@ -300,26 +300,26 @@ if (result.result === "success") {
300
300
301
301
> ** ClientOptions** = ` object `
302
302
303
- Defined in: [ sdk/hasura/src/hasura.ts:28] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L28 )
303
+ Defined in: [ sdk/hasura/src/hasura.ts:28] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L28 )
304
304
305
305
Type definition for client options derived from the ClientOptionsSchema.
306
306
307
307
##### Type declaration
308
308
309
309
| Name | Type | Default value | Defined in |
310
310
| ------ | ------ | ------ | ------ |
311
- | <a id =" accesstoken " ></a > ` accessToken? ` | ` string ` | - | [ sdk/hasura/src/hasura.ts:20] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L20 ) |
312
- | <a id =" adminsecret " ></a > ` adminSecret ` | ` string ` | - | [ sdk/hasura/src/hasura.ts:21] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L21 ) |
313
- | <a id =" cache " ></a > ` cache? ` | ` "default" ` \| ` "force-cache" ` \| ` "no-cache" ` \| ` "no-store" ` \| ` "only-if-cached" ` \| ` "reload" ` | - | [ sdk/hasura/src/hasura.ts:22] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L22 ) |
314
- | <a id =" instance " ></a > ` instance ` | ` string ` | ` UrlOrPathSchema ` | [ sdk/hasura/src/hasura.ts:19] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L19 ) |
311
+ | <a id =" accesstoken " ></a > ` accessToken? ` | ` string ` | - | [ sdk/hasura/src/hasura.ts:20] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L20 ) |
312
+ | <a id =" adminsecret " ></a > ` adminSecret ` | ` string ` | - | [ sdk/hasura/src/hasura.ts:21] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L21 ) |
313
+ | <a id =" cache " ></a > ` cache? ` | ` "default" ` \| ` "force-cache" ` \| ` "no-cache" ` \| ` "no-store" ` \| ` "only-if-cached" ` \| ` "reload" ` | - | [ sdk/hasura/src/hasura.ts:22] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L22 ) |
314
+ | <a id =" instance " ></a > ` instance ` | ` string ` | ` UrlOrPathSchema ` | [ sdk/hasura/src/hasura.ts:19] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L19 ) |
315
315
316
316
***
317
317
318
318
#### RequestConfig
319
319
320
320
> ** RequestConfig** = ` ConstructorParameters ` \< * typeof* ` GraphQLClient ` \>\[ ` 1 ` \]
321
321
322
- Defined in: [ sdk/hasura/src/hasura.ts:13] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L13 )
322
+ Defined in: [ sdk/hasura/src/hasura.ts:13] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L13 )
323
323
324
324
Type definition for GraphQL client configuration options
325
325
@@ -329,7 +329,7 @@ Type definition for GraphQL client configuration options
329
329
330
330
> ` const ` ** ClientOptionsSchema** : ` ZodObject ` \< [ ` ClientOptions ` ] ( #clientoptions ) \>
331
331
332
- Defined in: [ sdk/hasura/src/hasura.ts:18] ( https://github.com/settlemint/sdk/blob/v2.5.3 /sdk/hasura/src/hasura.ts#L18 )
332
+ Defined in: [ sdk/hasura/src/hasura.ts:18] ( https://github.com/settlemint/sdk/blob/v2.5.4 /sdk/hasura/src/hasura.ts#L18 )
333
333
334
334
Schema for validating client options for the Hasura client.
335
335
0 commit comments