Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Faet/docs search function in documentation #1236

Merged
merged 2 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ClientError.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Error.constructor

#### Defined in

sdk/src/types/errors.ts:27
[sdk/src/types/errors.ts:27](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L27)

## Properties

Expand Down Expand Up @@ -105,7 +105,7 @@ Additional error payload.

#### Defined in

sdk/src/types/errors.ts:20
[sdk/src/types/errors.ts:20](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L20)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ConfigurationError.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Error.constructor

#### Defined in

sdk/src/types/errors.ts:188
[sdk/src/types/errors.ts:188](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L188)

## Properties

Expand Down Expand Up @@ -103,7 +103,7 @@ Additional error payload.

#### Defined in

sdk/src/types/errors.ts:187
[sdk/src/types/errors.ts:187](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L187)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/ContractError.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Error.constructor

#### Defined in

sdk/src/types/errors.ts:43
[sdk/src/types/errors.ts:43](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L43)

## Properties

Expand Down Expand Up @@ -104,7 +104,7 @@ Additional error payload.

#### Defined in

sdk/src/types/errors.ts:41
[sdk/src/types/errors.ts:41](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L41)

---

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/FetchError.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Error.constructor

#### Defined in

sdk/src/types/errors.ts:65
[sdk/src/types/errors.ts:65](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L65)

## Properties

Expand Down Expand Up @@ -105,7 +105,7 @@ Additional error payload.

#### Defined in

sdk/src/types/errors.ts:58
[sdk/src/types/errors.ts:58](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L58)

---

Expand Down
54 changes: 27 additions & 27 deletions docs/docs/developer/api/sdk/classes/HypercertClient.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Will throw a `ClientError` if the public client cannot be connected.

#### Defined in

sdk/src/client.ts:55
[sdk/src/client.ts:55](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L55)

## Properties

Expand All @@ -64,7 +64,7 @@ sdk/src/client.ts:55

#### Defined in

sdk/src/client.ts:38
[sdk/src/client.ts:38](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L38)

---

Expand All @@ -74,7 +74,7 @@ sdk/src/client.ts:38

#### Defined in

sdk/src/client.ts:41
[sdk/src/client.ts:41](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L41)

---

Expand All @@ -84,7 +84,7 @@ sdk/src/client.ts:41

#### Defined in

sdk/src/client.ts:42
[sdk/src/client.ts:42](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L42)

---

Expand Down Expand Up @@ -158,7 +158,7 @@ sdk/src/client.ts:42

#### Defined in

sdk/src/client.ts:43
[sdk/src/client.ts:43](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L43)

---

Expand All @@ -168,7 +168,7 @@ sdk/src/client.ts:43

#### Defined in

sdk/src/client.ts:39
[sdk/src/client.ts:39](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L39)

---

Expand Down Expand Up @@ -212,7 +212,7 @@ sdk/src/client.ts:39

#### Defined in

sdk/src/client.ts:44
[sdk/src/client.ts:44](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L44)

---

Expand All @@ -228,7 +228,7 @@ Whether the client is in read-only mode.

#### Defined in

sdk/src/client.ts:45
[sdk/src/client.ts:45](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L45)

## Accessors

Expand All @@ -246,7 +246,7 @@ The client config.

#### Defined in

sdk/src/client.ts:79
[sdk/src/client.ts:79](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L79)

---

Expand All @@ -268,7 +268,7 @@ The contract.

#### Defined in

sdk/src/client.ts:103
[sdk/src/client.ts:103](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L103)

---

Expand All @@ -290,7 +290,7 @@ The indexer.

#### Defined in

sdk/src/client.ts:95
[sdk/src/client.ts:95](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L95)

---

Expand All @@ -312,7 +312,7 @@ The storage layer.

#### Defined in

sdk/src/client.ts:87
[sdk/src/client.ts:87](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L87)

## Methods

Expand Down Expand Up @@ -351,7 +351,7 @@ Will throw an `InvalidOrMissingError` if any of the proofs are invalid.

#### Defined in

sdk/src/client.ts:459
[sdk/src/client.ts:459](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L459)

---

Expand Down Expand Up @@ -384,7 +384,7 @@ A promise that resolves to the transaction hash.

#### Defined in

sdk/src/client.ts:210
[sdk/src/client.ts:210](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L210)

---

Expand Down Expand Up @@ -421,7 +421,7 @@ Will throw a `ClientError` if the claim is not owned by the account.

#### Defined in

sdk/src/client.ts:382
[sdk/src/client.ts:382](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L382)

---

Expand Down Expand Up @@ -462,7 +462,7 @@ Will throw a `MalformedDataError` if the provided allowlist or metadata is inval

#### Defined in

sdk/src/client.ts:243
[sdk/src/client.ts:243](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L243)

---

Expand All @@ -482,7 +482,7 @@ sdk/src/client.ts:243

#### Defined in

sdk/src/client.ts:499
[sdk/src/client.ts:499](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L499)

---

Expand All @@ -496,7 +496,7 @@ sdk/src/client.ts:499

#### Defined in

sdk/src/client.ts:490
[sdk/src/client.ts:490](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L490)

---

Expand Down Expand Up @@ -526,7 +526,7 @@ a Promise that resolves to the applicable transfer restrictions.

#### Defined in

sdk/src/client.ts:162
[sdk/src/client.ts:162](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L162)

---

Expand Down Expand Up @@ -574,7 +574,7 @@ sdk/src/client.ts:162

#### Defined in

sdk/src/client.ts:509
[sdk/src/client.ts:509](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L509)

---

Expand Down Expand Up @@ -611,7 +611,7 @@ Will throw a `ClientError` if any of the fractions are not owned by the account.

#### Defined in

sdk/src/client.ts:341
[sdk/src/client.ts:341](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L341)

---

Expand Down Expand Up @@ -651,7 +651,7 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.

#### Defined in

sdk/src/client.ts:127
[sdk/src/client.ts:127](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L127)

---

Expand Down Expand Up @@ -690,7 +690,7 @@ Will throw an `InvalidOrMissingError` if the proof is invalid.

#### Defined in

sdk/src/client.ts:415
[sdk/src/client.ts:415](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L415)

---

Expand All @@ -713,7 +713,7 @@ sdk/src/client.ts:415

#### Defined in

sdk/src/client.ts:519
[sdk/src/client.ts:519](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L519)

---

Expand Down Expand Up @@ -752,7 +752,7 @@ Will throw a `ClientError` if the fraction is not owned by the account or if the

#### Defined in

sdk/src/client.ts:296
[sdk/src/client.ts:296](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L296)

---

Expand Down Expand Up @@ -782,7 +782,7 @@ Will throw a `ClientError` if the request fails.

#### Defined in

sdk/src/client.ts:550
[sdk/src/client.ts:550](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L550)

---

Expand Down Expand Up @@ -815,4 +815,4 @@ A promise that resolves to the transaction hash.

#### Defined in

sdk/src/client.ts:182
[sdk/src/client.ts:182](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/client.ts#L182)
16 changes: 8 additions & 8 deletions docs/docs/developer/api/sdk/classes/HypercertsStorage.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ This constructor takes an optional `overrides` parameter that can be used to ove

#### Defined in

sdk/src/storage.ts:47
[sdk/src/storage.ts:47](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L47)

## Properties

Expand All @@ -58,7 +58,7 @@ The NFT Storage client used for storing and retrieving Hypercerts.

#### Defined in

sdk/src/storage.ts:36
[sdk/src/storage.ts:36](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L36)

---

Expand All @@ -70,7 +70,7 @@ Whether the storage is read-only. If true, the storage methods will not perform

#### Defined in

sdk/src/storage.ts:34
[sdk/src/storage.ts:34](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L34)

---

Expand All @@ -82,7 +82,7 @@ The Web3 Storage client used for storing and retrieving Hypercerts.

#### Defined in

sdk/src/storage.ts:38
[sdk/src/storage.ts:38](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L38)

## Methods

Expand Down Expand Up @@ -124,7 +124,7 @@ Note: The original implementation using the Web3 Storage client is currently com

#### Defined in

sdk/src/storage.ts:167
[sdk/src/storage.ts:167](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L167)

---

Expand Down Expand Up @@ -159,7 +159,7 @@ Will throw a `MalformedDataError` if the retrieved data is invalid.

#### Defined in

sdk/src/storage.ts:114
[sdk/src/storage.ts:114](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L114)

---

Expand Down Expand Up @@ -200,7 +200,7 @@ If you are using our default keys, we may delete older data if we hit our storag

#### Defined in

sdk/src/storage.ts:139
[sdk/src/storage.ts:139](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L139)

---

Expand Down Expand Up @@ -240,4 +240,4 @@ Will throw a `MalformedDataError` if the provided metadata is invalid.

#### Defined in

sdk/src/storage.ts:81
[sdk/src/storage.ts:81](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/storage.ts#L81)
4 changes: 2 additions & 2 deletions docs/docs/developer/api/sdk/classes/InvalidOrMissingError.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Error.constructor

#### Defined in

sdk/src/types/errors.ts:83
[sdk/src/types/errors.ts:83](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L83)

## Properties

Expand Down Expand Up @@ -105,7 +105,7 @@ Additional error payload.

#### Defined in

sdk/src/types/errors.ts:76
[sdk/src/types/errors.ts:76](https://github.com/hypercerts-org/hypercerts/blob/0793659/sdk/src/types/errors.ts#L76)

---

Expand Down
Loading
Loading