-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Loading status checks…
Fix @celo/base docs (#240)
* chore(sdk/base): fix typo in typedoc output path * docs(sdk/base): re-generates docs at new output path Re-generates docs at `./docs/` ```sh $ yarn workspace @celo/base docs ```
- @celo/wallet-rpc@6.0.3
- @celo/wallet-rpc@6.0.2
- @celo/wallet-rpc@6.0.1
- @celo/wallet-rpc@6.0.1-beta.0
- @celo/wallet-rpc@6.0.0
- @celo/wallet-rpc@6.0.0-beta.3
- @celo/wallet-rpc@6.0.0-beta.2
- @celo/wallet-rpc@6.0.0-beta.1
- @celo/wallet-rpc@6.0.0-beta.0
- @celo/wallet-remote@6.0.4
- @celo/wallet-remote@6.0.4-beta.1
- @celo/wallet-remote@6.0.4-beta.0
- @celo/wallet-remote@6.0.3
- @celo/wallet-remote@6.0.3-beta.1
- @celo/wallet-remote@6.0.2
- @celo/wallet-remote@6.0.2-beta.1
- @celo/wallet-remote@6.0.2-beta.0
- @celo/wallet-remote@6.0.1
- @celo/wallet-remote@6.0.1-beta.0
- @celo/wallet-remote@6.0.0
- @celo/wallet-remote@6.0.0-beta.3
- @celo/wallet-remote@6.0.0-beta.2
- @celo/wallet-remote@6.0.0-beta.1
- @celo/wallet-remote@6.0.0-beta.0
- @celo/wallet-local@6.0.4
- @celo/wallet-local@6.0.4-beta.1
- @celo/wallet-local@6.0.4-beta.0
- @celo/wallet-local@6.0.3
- @celo/wallet-local@6.0.3-beta.1
- @celo/wallet-local@6.0.2
- @celo/wallet-local@6.0.2-beta.1
- @celo/wallet-local@6.0.2-beta.0
- @celo/wallet-local@6.0.1
- @celo/wallet-local@6.0.1-beta.0
- @celo/wallet-local@6.0.0
- @celo/wallet-local@6.0.0-beta.3
- @celo/wallet-local@6.0.0-beta.2
- @celo/wallet-local@6.0.0-beta.1
- @celo/wallet-local@6.0.0-beta.0
- @celo/wallet-ledger@6.0.4
- @celo/wallet-ledger@6.0.4-beta.1
- @celo/wallet-ledger@6.0.4-beta.0
- @celo/wallet-ledger@6.0.3
- @celo/wallet-ledger@6.0.3-beta.1
- @celo/wallet-ledger@6.0.2
- @celo/wallet-ledger@6.0.2-beta.1
- @celo/wallet-ledger@6.0.2-beta.0
- @celo/wallet-ledger@6.0.1
- @celo/wallet-ledger@6.0.1-beta.0
- @celo/wallet-ledger@6.0.0
- @celo/wallet-ledger@6.0.0-beta.3
- @celo/wallet-ledger@6.0.0-beta.2
- @celo/wallet-ledger@6.0.0-beta.1
- @celo/wallet-ledger@6.0.0-beta.0
- @celo/wallet-hsm-gcp@6.0.4
- @celo/wallet-hsm-gcp@6.0.4-beta.1
- @celo/wallet-hsm-gcp@6.0.4-beta.0
- @celo/wallet-hsm-gcp@6.0.3
- @celo/wallet-hsm-gcp@6.0.3-beta.1
- @celo/wallet-hsm-gcp@6.0.2
- @celo/wallet-hsm-gcp@6.0.2-beta.1
- @celo/wallet-hsm-gcp@6.0.2-beta.0
- @celo/wallet-hsm-gcp@6.0.1
- @celo/wallet-hsm-gcp@6.0.1-beta.0
- @celo/wallet-hsm-gcp@6.0.0
- @celo/wallet-hsm-gcp@6.0.0-beta.3
- @celo/wallet-hsm-gcp@6.0.0-beta.2
- @celo/wallet-hsm-gcp@6.0.0-beta.1
- @celo/wallet-hsm-gcp@6.0.0-beta.0
- @celo/wallet-hsm-azure@6.0.4
- @celo/wallet-hsm-azure@6.0.4-beta.1
- @celo/wallet-hsm-azure@6.0.4-beta.0
- @celo/wallet-hsm-azure@6.0.3
- @celo/wallet-hsm-azure@6.0.3-beta.1
- @celo/wallet-hsm-azure@6.0.2
- @celo/wallet-hsm-azure@6.0.2-beta.1
- @celo/wallet-hsm-azure@6.0.2-beta.0
- @celo/wallet-hsm-azure@6.0.1
- @celo/wallet-hsm-azure@6.0.1-beta.0
- @celo/wallet-hsm-azure@6.0.0
- @celo/wallet-hsm-azure@6.0.0-beta.3
- @celo/wallet-hsm-azure@6.0.0-beta.2
- @celo/wallet-hsm-azure@6.0.0-beta.1
- @celo/wallet-hsm-azure@6.0.0-beta.0
- @celo/wallet-hsm-aws@6.0.4
- @celo/wallet-hsm-aws@6.0.4-beta.1
- @celo/wallet-hsm-aws@6.0.4-beta.0
- @celo/wallet-hsm-aws@6.0.3
- @celo/wallet-hsm-aws@6.0.3-beta.1
- @celo/wallet-hsm-aws@6.0.2
- @celo/wallet-hsm-aws@6.0.2-beta.1
- @celo/wallet-hsm-aws@6.0.2-beta.0
- @celo/wallet-hsm-aws@6.0.1
- @celo/wallet-hsm-aws@6.0.1-beta.0
- @celo/wallet-hsm-aws@6.0.0
- @celo/wallet-hsm-aws@6.0.0-beta.3
- @celo/wallet-hsm-aws@6.0.0-beta.2
- @celo/wallet-hsm-aws@6.0.0-beta.1
- @celo/wallet-hsm-aws@6.0.0-beta.0
- @celo/wallet-hsm@6.0.4
- @celo/wallet-hsm@6.0.4-beta.1
- @celo/wallet-hsm@6.0.4-beta.0
- @celo/wallet-hsm@6.0.3
- @celo/wallet-hsm@6.0.3-beta.1
- @celo/wallet-hsm@6.0.2
- @celo/wallet-hsm@6.0.2-beta.1
- @celo/wallet-hsm@6.0.2-beta.0
- @celo/wallet-hsm@6.0.1
- @celo/wallet-hsm@6.0.1-beta.0
- @celo/wallet-hsm@6.0.0
- @celo/wallet-hsm@6.0.0-beta.3
- @celo/wallet-hsm@6.0.0-beta.2
- @celo/wallet-hsm@6.0.0-beta.1
- @celo/wallet-hsm@6.0.0-beta.0
- @celo/wallet-base@6.0.4
- @celo/wallet-base@6.0.4-beta.1
- @celo/wallet-base@6.0.4-beta.0
- @celo/wallet-base@6.0.3
- @celo/wallet-base@6.0.3-beta.1
- @celo/wallet-base@6.0.2
- @celo/wallet-base@6.0.2-beta.1
- @celo/wallet-base@6.0.2-beta.0
- @celo/wallet-base@6.0.1
- @celo/wallet-base@6.0.1-beta.0
- @celo/wallet-base@6.0.0
- @celo/wallet-base@6.0.0-beta.3
- @celo/wallet-base@6.0.0-beta.2
- @celo/wallet-base@6.0.0-beta.1
- @celo/wallet-base@6.0.0-beta.0
- @celo/viem-account-ledger@1.0.0
- @celo/viem-account-ledger@1.0.0-beta.2
- @celo/viem-account-ledger@1.0.0-beta.0
- @celo/utils@8.0.0
- @celo/utils@8.0.0-beta.0
- @celo/utils@7.0.0
- @celo/utils@7.0.0-beta.0
- @celo/transactions-uri@5.0.12
- @celo/transactions-uri@5.0.12-beta.1
- @celo/transactions-uri@5.0.12-beta.0
- @celo/transactions-uri@5.0.11
- @celo/transactions-uri@5.0.11-beta.0
- @celo/transactions-uri@5.0.10
- @celo/transactions-uri@5.0.10-beta.1
- @celo/transactions-uri@5.0.10-beta.0
- @celo/phone-utils@6.0.4
- @celo/phone-utils@6.0.4-beta.0
- @celo/phone-utils@6.0.3
- @celo/phone-utils@6.0.3-beta.0
- @celo/metadata-claims@1.0.0
- @celo/metadata-claims@1.0.0-beta.2
- @celo/metadata-claims@1.0.0-beta.1
- @celo/metadata-claims@1.0.0-beta.0
- @celo/keystores@5.0.12
- @celo/keystores@5.0.12-beta.0
- @celo/keystores@5.0.11
- @celo/keystores@5.0.11-beta.0
- @celo/keystores@5.0.10
- @celo/keystores@5.0.10-beta.0
- @celo/governance@5.1.4
- @celo/governance@5.1.4-beta.3
- @celo/governance@5.1.4-beta.2
- @celo/governance@5.1.4-beta.1
- @celo/governance@5.1.4-beta.0
- @celo/governance@5.1.3
- @celo/governance@5.1.3-beta.0
- @celo/governance@5.1.2
- @celo/governance@5.1.2-beta.0
- @celo/explorer@5.0.13
- @celo/explorer@5.0.13-beta.1
- @celo/explorer@5.0.13-beta.0
- @celo/explorer@5.0.12
- @celo/explorer@5.0.12-beta.0
- @celo/explorer@5.0.11
- @celo/explorer@5.0.11-beta.0
- @celo/dev-utils@0.0.7
- @celo/dev-utils@0.0.7-beta.2
- @celo/dev-utils@0.0.7-beta.1
- @celo/dev-utils@0.0.6
- @celo/dev-utils@0.0.6-beta.1
- @celo/dev-utils@0.0.6-beta.0
- @celo/dev-utils@0.0.5
- @celo/dev-utils@0.0.5-beta.0
- @celo/dev-utils@0.0.4
- @celo/dev-utils@0.0.4-beta.1
- @celo/dev-utils@0.0.4-beta.0
- @celo/cryptographic-utils@5.1.1
- @celo/cryptographic-utils@5.1.1-beta.0
- @celo/cryptographic-utils@5.1.0
- @celo/cryptographic-utils@5.1.0-beta.0
- @celo/contractkit@9.0.0
- @celo/contractkit@9.0.0-beta.5
- @celo/contractkit@9.0.0-beta.4
- @celo/contractkit@9.0.0-beta.3
- @celo/contractkit@9.0.0-beta.2
- @celo/contractkit@9.0.0-beta.1
- @celo/contractkit@9.0.0-beta.0
- @celo/contractkit@8.3.1
- @celo/contractkit@8.3.0
- @celo/contractkit@8.2.0
- @celo/contractkit@8.1.1
- @celo/contractkit@8.1.1-beta.0
- @celo/contractkit@8.1.0
- @celo/contractkit@8.1.0-beta.1
- @celo/contractkit@8.1.0-beta.0
- @celo/connect@6.1.0
- @celo/connect@6.1.0-beta.1
- @celo/connect@6.0.3-beta.0
- @celo/connect@6.0.2
- @celo/connect@6.0.1
- @celo/connect@6.0.1-beta.0
- @celo/connect@6.0.0
- @celo/connect@6.0.0-beta.1
- @celo/connect@6.0.0-beta.0
- @celo/celocli@6.0.0
- @celo/celocli@6.0.0-beta.7
- @celo/celocli@6.0.0-beta.6
- @celo/celocli@6.0.0-beta.5
- @celo/celocli@6.0.0-beta.4
- @celo/celocli@6.0.0-beta.3
- @celo/celocli@6.0.0-beta.1
- @celo/celocli@6.0.0-beta.0
- @celo/celocli@5.2.3
- @celo/celocli@5.2.2
- @celo/celocli@5.2.1
- @celo/celocli@5.2.0
- @celo/celocli@5.1.1
- @celo/celocli@5.1.1-beta.0
- @celo/celocli@5.1.0
- @celo/celocli@5.1.0-beta.3
- @celo/celocli@5.1.0-beta.2
- @celo/celocli@5.1.0-beta.1
- @celo/celocli@5.1.0-beta.0
- @celo/base@7.0.0
- @celo/base@7.0.0-beta.1
- @celo/base@7.0.0-beta.0
- @celo/base@6.1.0
- @celo/base@6.1.0-beta.0
1 parent
97b5b7b
commit d05deab
Showing
49 changed files
with
4,655 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,28 @@ | ||
@celo/base | ||
|
||
# @celo/base | ||
|
||
## Table of contents | ||
|
||
### Modules | ||
|
||
- [account](modules/account.md) | ||
- [address](modules/address.md) | ||
- [async](modules/async.md) | ||
- [collections](modules/collections.md) | ||
- [contacts](modules/contacts.md) | ||
- [currencies](modules/currencies.md) | ||
- [displayFormatting](modules/displayFormatting.md) | ||
- [future](modules/future.md) | ||
- [index](modules/index.md) | ||
- [inputValidation](modules/inputValidation.md) | ||
- [io](modules/io.md) | ||
- [lock](modules/lock.md) | ||
- [logger](modules/logger.md) | ||
- [parsing](modules/parsing.md) | ||
- [phoneNumbers](modules/phoneNumbers.md) | ||
- [result](modules/result.md) | ||
- [signatureUtils](modules/signatureUtils.md) | ||
- [string](modules/string.md) | ||
- [task](modules/task.md) | ||
- [types](modules/types.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,145 @@ | ||
[@celo/base](../README.md) / [future](../modules/future.md) / Future | ||
|
||
# Class: Future\<T\> | ||
|
||
[future](../modules/future.md).Future | ||
|
||
## Type parameters | ||
|
||
| Name | | ||
| :------ | | ||
| `T` | | ||
|
||
## Table of contents | ||
|
||
### Constructors | ||
|
||
- [constructor](future.Future.md#constructor) | ||
|
||
### Accessors | ||
|
||
- [error](future.Future.md#error) | ||
- [finished](future.Future.md#finished) | ||
|
||
### Methods | ||
|
||
- [asPromise](future.Future.md#aspromise) | ||
- [reject](future.Future.md#reject) | ||
- [resolve](future.Future.md#resolve) | ||
- [wait](future.Future.md#wait) | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new Future**\<`T`\>(): [`Future`](future.Future.md)\<`T`\> | ||
|
||
#### Type parameters | ||
|
||
| Name | | ||
| :------ | | ||
| `T` | | ||
|
||
#### Returns | ||
|
||
[`Future`](future.Future.md)\<`T`\> | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:10](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L10) | ||
|
||
## Accessors | ||
|
||
### error | ||
|
||
• `get` **error**(): `any` | ||
|
||
#### Returns | ||
|
||
`any` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:21](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L21) | ||
|
||
___ | ||
|
||
### finished | ||
|
||
• `get` **finished**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:17](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L17) | ||
|
||
## Methods | ||
|
||
### asPromise | ||
|
||
▸ **asPromise**(): `Promise`\<`T`\> | ||
|
||
#### Returns | ||
|
||
`Promise`\<`T`\> | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:41](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L41) | ||
|
||
___ | ||
|
||
### reject | ||
|
||
▸ **reject**(`error`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `error` | `any` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:31](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L31) | ||
|
||
___ | ||
|
||
### resolve | ||
|
||
▸ **resolve**(`value`): `void` | ||
|
||
#### Parameters | ||
|
||
| Name | Type | | ||
| :------ | :------ | | ||
| `value` | `T` | | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:25](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L25) | ||
|
||
___ | ||
|
||
### wait | ||
|
||
▸ **wait**(): `Promise`\<`T`\> | ||
|
||
#### Returns | ||
|
||
`Promise`\<`T`\> | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/future.ts:37](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/future.ts#L37) |
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,73 @@ | ||
[@celo/base](../README.md) / [lock](../modules/lock.md) / Lock | ||
|
||
# Class: Lock | ||
|
||
[lock](../modules/lock.md).Lock | ||
|
||
## Table of contents | ||
|
||
### Constructors | ||
|
||
- [constructor](lock.Lock.md#constructor) | ||
|
||
### Methods | ||
|
||
- [acquire](lock.Lock.md#acquire) | ||
- [release](lock.Lock.md#release) | ||
- [tryAcquire](lock.Lock.md#tryacquire) | ||
|
||
## Constructors | ||
|
||
### constructor | ||
|
||
• **new Lock**(): [`Lock`](lock.Lock.md) | ||
|
||
#### Returns | ||
|
||
[`Lock`](lock.Lock.md) | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/lock.ts:14](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L14) | ||
|
||
## Methods | ||
|
||
### acquire | ||
|
||
▸ **acquire**(): `Promise`\<`void`\> | ||
|
||
#### Returns | ||
|
||
`Promise`\<`void`\> | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/lock.ts:29](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L29) | ||
|
||
___ | ||
|
||
### release | ||
|
||
▸ **release**(): `void` | ||
|
||
#### Returns | ||
|
||
`void` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/lock.ts:54](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L54) | ||
|
||
___ | ||
|
||
### tryAcquire | ||
|
||
▸ **tryAcquire**(): `boolean` | ||
|
||
#### Returns | ||
|
||
`boolean` | ||
|
||
#### Defined in | ||
|
||
[packages/sdk/base/src/lock.ts:20](https://github.com/celo-org/developer-tooling/blob/master/packages/sdk/base/src/lock.ts#L20) |
Oops, something went wrong.