-
Notifications
You must be signed in to change notification settings - Fork 746
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: generate documentation version
- Loading branch information
Showing
169 changed files
with
132,380 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
label: 'API' |
1,711 changes: 1,711 additions & 0 deletions
1,711
www/versioned_docs/version-5.24.3/API/classes/Account.md
Large diffs are not rendered by default.
Oops, something went wrong.
1,246 changes: 1,246 additions & 0 deletions
1,246
www/versioned_docs/version-5.24.3/API/classes/AccountInterface.md
Large diffs are not rendered by default.
Oops, something went wrong.
87 changes: 87 additions & 0 deletions
87
www/versioned_docs/version-5.24.3/API/classes/CairoCustomEnum.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,87 @@ | ||
--- | ||
id: 'CairoCustomEnum' | ||
title: 'Class: CairoCustomEnum' | ||
sidebar_label: 'CairoCustomEnum' | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
Class to handle Cairo custom Enum | ||
|
||
**`Param`** | ||
|
||
object containing the variants and its content. Example : | ||
{Success: 234, Warning: undefined, Error: undefined}. | ||
Only one variant with a value, object, array. | ||
|
||
**`Example`** | ||
|
||
```typescript | ||
const myCairoEnum = new CairoCustomEnum( {Success: undefined, Warning: "0x7f32ea", Error: undefined}) | ||
``` | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new CairoCustomEnum**(`enumContent`) | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| :------------ | :------------------------------------------- | :----------------------------------------------------------------------------------------------- | | ||
| `enumContent` | [`CairoEnumRaw`](../modules.md#cairoenumraw) | an object with the variants as keys and the content as value. Only one content shall be defined. | | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoCustomEnum.ts:27](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoCustomEnum.ts#L27) | ||
|
||
## Properties | ||
|
||
### variant | ||
|
||
• `Readonly` **variant**: [`CairoEnumRaw`](../modules.md#cairoenumraw) | ||
|
||
direct readonly access to variants of the Cairo Custom Enum. | ||
|
||
**`Example`** | ||
|
||
```typescript | ||
const successValue = myCairoEnum.variant.Success; | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoCustomEnum.ts:22](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoCustomEnum.ts#L22) | ||
|
||
## Methods | ||
|
||
### unwrap | ||
|
||
▸ **unwrap**(): `any` | ||
|
||
#### Returns | ||
|
||
`any` | ||
|
||
the content of the valid variant of a Cairo custom Enum. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoCustomEnum.ts:45](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoCustomEnum.ts#L45) | ||
|
||
___ | ||
|
||
### activeVariant | ||
|
||
▸ **activeVariant**(): `string` | ||
|
||
#### Returns | ||
|
||
`string` | ||
|
||
the name of the valid variant of a Cairo custom Enum. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoCustomEnum.ts:58](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoCustomEnum.ts#L58) | ||
``` |
121 changes: 121 additions & 0 deletions
121
www/versioned_docs/version-5.24.3/API/classes/CairoOption.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
--- | ||
id: 'CairoOption' | ||
title: 'Class: CairoOption<T>' | ||
sidebar_label: 'CairoOption' | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
Class to handle Cairo Option | ||
|
||
**`Param`** | ||
|
||
CairoOptionVariant.Some or CairoOptionVariant.None | ||
|
||
**`Param`** | ||
|
||
value of type T. | ||
|
||
**`Example`** | ||
|
||
```typescript | ||
const myOption = new CairoOption<BigNumberish>(CairoOptionVariant.Some, "0x54dda8"); | ||
``` | ||
|
||
## Type parameters | ||
|
||
| Name | | ||
| :--- | | ||
| `T` | | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new CairoOption**<`T`\>(`variant`, `someContent?`) | ||
|
||
#### Type parameters | ||
|
||
| Name | | ||
| :--- | | ||
| `T` | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------------- | :----------------------------------------------------- | | ||
| `variant` | [`CairoOptionVariant`](../enums/CairoOptionVariant.md) | | ||
| `someContent?` | `T` | | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:20](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L20) | ||
|
||
## Properties | ||
|
||
### Some | ||
|
||
• `Optional` `Readonly` **Some**: `T` | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:16](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L16) | ||
|
||
--- | ||
|
||
### None | ||
|
||
• `Optional` `Readonly` **None**: `boolean` | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:18](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L18) | ||
|
||
## Methods | ||
|
||
### unwrap | ||
|
||
▸ **unwrap**(): `undefined` \| `T` | ||
|
||
#### Returns | ||
|
||
`undefined` \| `T` | ||
|
||
the content of the valid variant of a Cairo custom Enum. | ||
If None, returns 'undefined'. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:43](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L43) | ||
|
||
--- | ||
|
||
### isSome | ||
|
||
▸ **isSome**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
true if the valid variant is 'isSome'. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:54](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L54) | ||
|
||
--- | ||
|
||
### isNone | ||
|
||
▸ **isNone**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
true if the valid variant is 'isNone'. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoOption.ts:62](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoOption.ts#L62) |
122 changes: 122 additions & 0 deletions
122
www/versioned_docs/version-5.24.3/API/classes/CairoResult.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
--- | ||
id: 'CairoResult' | ||
title: 'Class: CairoResult<T, U>' | ||
sidebar_label: 'CairoResult' | ||
sidebar_position: 0 | ||
custom_edit_url: null | ||
--- | ||
|
||
Class to handle Cairo Result | ||
|
||
**`Param`** | ||
|
||
CairoResultVariant.Ok or CairoResultVariant.Err | ||
|
||
**`Param`** | ||
|
||
value of type T or U. | ||
|
||
**`Example`** | ||
|
||
```typescript | ||
const myOption = new CairoResult<BigNumberish, CustomError>(CairoResultVariant.Ok, "0x54dda8"); | ||
``` | ||
|
||
## Type parameters | ||
|
||
| Name | | ||
| :--- | | ||
| `T` | | ||
| `U` | | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new CairoResult**<`T`, `U`\>(`variant`, `resultContent`) | ||
|
||
#### Type parameters | ||
|
||
| Name | | ||
| :--- | | ||
| `T` | | ||
| `U` | | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :-------------- | :----------------------------------------------------- | | ||
| `variant` | [`CairoResultVariant`](../enums/CairoResultVariant.md) | | ||
| `resultContent` | `T` \| `U` | | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:20](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L20) | ||
|
||
## Properties | ||
|
||
### Ok | ||
|
||
• `Optional` `Readonly` **Ok**: `T` | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:16](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L16) | ||
|
||
--- | ||
|
||
### Err | ||
|
||
• `Optional` `Readonly` **Err**: `U` | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:18](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L18) | ||
|
||
## Methods | ||
|
||
### unwrap | ||
|
||
▸ **unwrap**(): `T` \| `U` | ||
|
||
#### Returns | ||
|
||
`T` \| `U` | ||
|
||
the content of the valid variant of a Cairo Result. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:37](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L37) | ||
|
||
--- | ||
|
||
### isOk | ||
|
||
▸ **isOk**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
true if the valid variant is 'Ok'. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:51](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L51) | ||
|
||
--- | ||
|
||
### isErr | ||
|
||
▸ **isErr**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
true if the valid variant is 'isErr'. | ||
|
||
#### Defined in | ||
|
||
[src/utils/calldata/enum/CairoResult.ts:59](https://github.com/starknet-io/starknet.js/blob/v5.24.3/src/utils/calldata/enum/CairoResult.ts#L59) |
Oops, something went wrong.