@settlemint/sdk-js 2.4.0-pr3fd1ae9a → 2.4.0-pr4d875c05
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +5 -5
- package/dist/settlemint.cjs +31 -445
- package/dist/settlemint.cjs.map +1 -1
- package/dist/settlemint.d.cts +424 -40956
- package/dist/settlemint.d.ts +423 -40954
- package/dist/settlemint.js +31 -445
- package/dist/settlemint.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -62,7 +62,7 @@ The SettleMint JavaScript SDK provides a type-safe wrapper around the SettleMint
|
|
|
62
62
|
|
|
63
63
|
> **createSettleMintClient**(`options`): [`SettlemintClient`](#settlemintclient)
|
|
64
64
|
|
|
65
|
-
Defined in: [settlemint.ts:
|
|
65
|
+
Defined in: [settlemint.ts:239](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/settlemint.ts#L239)
|
|
66
66
|
|
|
67
67
|
Creates a SettleMint client with the provided options. The client provides methods to interact with
|
|
68
68
|
various SettleMint resources like workspaces, applications, blockchain networks, blockchain nodes, middleware,
|
|
@@ -109,7 +109,7 @@ const workspace = await client.workspace.read('workspace-unique-name');
|
|
|
109
109
|
|
|
110
110
|
#### SettlemintClient
|
|
111
111
|
|
|
112
|
-
Defined in: [settlemint.ts:
|
|
112
|
+
Defined in: [settlemint.ts:127](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/settlemint.ts#L127)
|
|
113
113
|
|
|
114
114
|
Client interface for interacting with the SettleMint platform.
|
|
115
115
|
|
|
@@ -117,7 +117,7 @@ Client interface for interacting with the SettleMint platform.
|
|
|
117
117
|
|
|
118
118
|
#### SettlemintClientOptions
|
|
119
119
|
|
|
120
|
-
Defined in: [settlemint.ts:
|
|
120
|
+
Defined in: [settlemint.ts:117](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/settlemint.ts#L117)
|
|
121
121
|
|
|
122
122
|
Options for the Settlemint client.
|
|
123
123
|
|
|
@@ -129,8 +129,8 @@ Options for the Settlemint client.
|
|
|
129
129
|
|
|
130
130
|
| Property | Type | Default value | Description | Inherited from | Defined in |
|
|
131
131
|
| ------ | ------ | ------ | ------ | ------ | ------ |
|
|
132
|
-
| <a id="accesstoken"></a> `accessToken?` | `string` | `undefined` | The access token used to authenticate with the SettleMint platform | - | [settlemint.ts:
|
|
133
|
-
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:
|
|
132
|
+
| <a id="accesstoken"></a> `accessToken?` | `string` | `undefined` | The access token used to authenticate with the SettleMint platform | - | [settlemint.ts:119](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/settlemint.ts#L119) |
|
|
133
|
+
| <a id="anonymous"></a> `anonymous?` | `boolean` | `undefined` | Whether to allow anonymous access (no access token required) | - | [settlemint.ts:121](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/settlemint.ts#L121) |
|
|
134
134
|
| <a id="instance"></a> `instance` | `string` | `UrlSchema` | The URL of the SettleMint instance to connect to | `Omit.instance` | [helpers/client-options.schema.ts:11](https://github.com/settlemint/sdk/blob/v2.4.0/sdk/js/src/helpers/client-options.schema.ts#L11) |
|
|
135
135
|
|
|
136
136
|
### Type Aliases
|