Skip to content

fix: fix core-sdk definitions #267

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.

Sign up for GitHub

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

Closed
Cafe137 wants to merge 1 commit into from
Closed

fix: fix core-sdk definitions #267

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 18 additions & 18 deletions docs/api/classes/BatchId.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: BatchId

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/batch-id.d.cts:5
Defined in: [core-sdk/src/bytes/batch-id.ts:6](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/batch-id.ts#L6)

A 32-byte postage batch identifier.

Expand All @@ -14,7 +14,7 @@ A 32-byte postage batch identifier.

> **new BatchId**(`bytes`): `BatchId`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/batch-id.d.cts:7
Defined in: [core-sdk/src/bytes/batch-id.ts:9](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/batch-id.ts#L9)

#### Parameters

Expand All @@ -36,7 +36,7 @@ Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/batch-id.d.cts

> `readonly` **length**: `number`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:7
Defined in: [core-sdk/src/bytes/bytes.ts:19](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L19)

#### Inherited from

Expand All @@ -48,15 +48,15 @@ Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:7

> `readonly` `static` **LENGTH**: `32` = `32`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/batch-id.d.cts:6
Defined in: [core-sdk/src/bytes/batch-id.ts:7](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/batch-id.ts#L7)

## Methods

### equals()

> **equals**(`other`): `boolean`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:65
Defined in: [core-sdk/src/bytes/bytes.ts:166](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L166)

Byte-wise equality against another Bytes instance, raw bytes, or hex string.

Expand All @@ -80,7 +80,7 @@ Byte-wise equality against another Bytes instance, raw bytes, or hex string.

> **offset**(`index`): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:33
Defined in: [core-sdk/src/bytes/bytes.ts:110](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L110)

Returns a copy of the bytes from `index` to the end.

Expand All @@ -104,7 +104,7 @@ Returns a copy of the bytes from `index` to the end.

> **represent**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:69
Defined in: [core-sdk/src/bytes/bytes.ts:173](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L173)

Human-readable representation, used by debuggers/loggers. Same as [toHex](Bytes.md#tohex).

Expand All @@ -122,7 +122,7 @@ Human-readable representation, used by debuggers/loggers. Same as [toHex](Bytes.

> **toBase32**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:49
Defined in: [core-sdk/src/bytes/bytes.ts:138](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L138)

Encodes as a padded base32 string.

Expand All @@ -140,7 +140,7 @@ Encodes as a padded base32 string.

> **toBase64**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:45
Defined in: [core-sdk/src/bytes/bytes.ts:131](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L131)

Encodes as a padded base64 string.

Expand All @@ -158,7 +158,7 @@ Encodes as a padded base64 string.

> **toHex**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:41
Defined in: [core-sdk/src/bytes/bytes.ts:124](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L124)

Encodes as a lowercase hex string, with no `0x` prefix.

Expand All @@ -176,7 +176,7 @@ Encodes as a lowercase hex string, with no `0x` prefix.

> **toJSON**(): `unknown`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:61
Defined in: [core-sdk/src/bytes/bytes.ts:159](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L159)

Decodes the bytes as UTF-8 JSON.

Expand All @@ -194,7 +194,7 @@ Decodes the bytes as UTF-8 JSON.

> **toString**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:53
Defined in: [core-sdk/src/bytes/bytes.ts:145](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L145)

Same as [toHex](Bytes.md#tohex).

Expand All @@ -212,7 +212,7 @@ Same as [toHex](Bytes.md#tohex).

> **toUint8Array**(): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:37
Defined in: [core-sdk/src/bytes/bytes.ts:117](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L117)

Returns a copy of the underlying bytes.

Expand All @@ -230,7 +230,7 @@ Returns a copy of the underlying bytes.

> **toUtf8**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:57
Defined in: [core-sdk/src/bytes/bytes.ts:152](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L152)

Decodes the bytes as UTF-8 text.

Expand All @@ -248,7 +248,7 @@ Decodes the bytes as UTF-8 text.

> `static` **concat**(...`arrays`): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:20
Defined in: [core-sdk/src/bytes/bytes.ts:75](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L75)

Concatenates any number of byte arrays (or Bytes instances) into one new array.

Expand All @@ -272,7 +272,7 @@ Concatenates any number of byte arrays (or Bytes instances) into one new array.

> `static` **fromSlice**(`bytes`, `start`, `length?`): [`Bytes`](Bytes.md)

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:29
Defined in: [core-sdk/src/bytes/bytes.ts:100](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L100)

Wraps a slice of `bytes` starting at `start`, running to the end unless
`length` is given.
Expand Down Expand Up @@ -305,7 +305,7 @@ Wraps a slice of `bytes` starting at `start`, running to the end unless

> `static` **fromUtf8**(`utf8`): [`Bytes`](Bytes.md)

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:24
Defined in: [core-sdk/src/bytes/bytes.ts:92](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L92)

Wraps the UTF-8 encoding of a string.

Expand All @@ -329,7 +329,7 @@ Wraps the UTF-8 encoding of a string.

> `static` **keccak256**(`bytes`): [`Bytes`](Bytes.md)

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:16
Defined in: [core-sdk/src/bytes/bytes.ts:68](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L68)

Hashes `bytes` with keccak256 and wraps the 32-byte digest.

Expand Down
34 changes: 17 additions & 17 deletions docs/api/classes/Bytes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: Bytes

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:5
Defined in: [core-sdk/src/bytes/bytes.ts:17](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L17)

Base wrapper around a byte array, accepting a Uint8Array, ArrayBuffer, hex
string, or another Bytes instance, with an optional length check.
Expand All @@ -26,7 +26,7 @@ string, or another Bytes instance, with an optional length check.

> **new Bytes**(`bytes`, `byteLength?`): `Bytes`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:12
Defined in: [core-sdk/src/bytes/bytes.ts:25](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L25)

#### Parameters

Expand All @@ -51,15 +51,15 @@ If given, throws unless the resulting length matches

> `readonly` **length**: `number`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:7
Defined in: [core-sdk/src/bytes/bytes.ts:19](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L19)

## Methods

### equals()

> **equals**(`other`): `boolean`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:65
Defined in: [core-sdk/src/bytes/bytes.ts:166](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L166)

Byte-wise equality against another Bytes instance, raw bytes, or hex string.

Expand All @@ -79,7 +79,7 @@ Byte-wise equality against another Bytes instance, raw bytes, or hex string.

> **offset**(`index`): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:33
Defined in: [core-sdk/src/bytes/bytes.ts:110](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L110)

Returns a copy of the bytes from `index` to the end.

Expand All @@ -99,7 +99,7 @@ Returns a copy of the bytes from `index` to the end.

> **represent**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:69
Defined in: [core-sdk/src/bytes/bytes.ts:173](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L173)

Human-readable representation, used by debuggers/loggers. Same as [toHex](#tohex).

Expand All @@ -113,7 +113,7 @@ Human-readable representation, used by debuggers/loggers. Same as [toHex](#tohex

> **toBase32**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:49
Defined in: [core-sdk/src/bytes/bytes.ts:138](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L138)

Encodes as a padded base32 string.

Expand All @@ -127,7 +127,7 @@ Encodes as a padded base32 string.

> **toBase64**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:45
Defined in: [core-sdk/src/bytes/bytes.ts:131](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L131)

Encodes as a padded base64 string.

Expand All @@ -141,7 +141,7 @@ Encodes as a padded base64 string.

> **toHex**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:41
Defined in: [core-sdk/src/bytes/bytes.ts:124](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L124)

Encodes as a lowercase hex string, with no `0x` prefix.

Expand All @@ -155,7 +155,7 @@ Encodes as a lowercase hex string, with no `0x` prefix.

> **toJSON**(): `unknown`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:61
Defined in: [core-sdk/src/bytes/bytes.ts:159](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L159)

Decodes the bytes as UTF-8 JSON.

Expand All @@ -169,7 +169,7 @@ Decodes the bytes as UTF-8 JSON.

> **toString**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:53
Defined in: [core-sdk/src/bytes/bytes.ts:145](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L145)

Same as [toHex](#tohex).

Expand All @@ -183,7 +183,7 @@ Same as [toHex](#tohex).

> **toUint8Array**(): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:37
Defined in: [core-sdk/src/bytes/bytes.ts:117](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L117)

Returns a copy of the underlying bytes.

Expand All @@ -197,7 +197,7 @@ Returns a copy of the underlying bytes.

> **toUtf8**(): `string`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:57
Defined in: [core-sdk/src/bytes/bytes.ts:152](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L152)

Decodes the bytes as UTF-8 text.

Expand All @@ -211,7 +211,7 @@ Decodes the bytes as UTF-8 text.

> `static` **concat**(...`arrays`): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:20
Defined in: [core-sdk/src/bytes/bytes.ts:75](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L75)

Concatenates any number of byte arrays (or Bytes instances) into one new array.

Expand All @@ -231,7 +231,7 @@ Concatenates any number of byte arrays (or Bytes instances) into one new array.

> `static` **fromSlice**(`bytes`, `start`, `length?`): `Bytes`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:29
Defined in: [core-sdk/src/bytes/bytes.ts:100](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L100)

Wraps a slice of `bytes` starting at `start`, running to the end unless
`length` is given.
Expand Down Expand Up @@ -260,7 +260,7 @@ Wraps a slice of `bytes` starting at `start`, running to the end unless

> `static` **fromUtf8**(`utf8`): `Bytes`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:24
Defined in: [core-sdk/src/bytes/bytes.ts:92](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L92)

Wraps the UTF-8 encoding of a string.

Expand All @@ -280,7 +280,7 @@ Wraps the UTF-8 encoding of a string.

> `static` **keccak256**(`bytes`): `Bytes`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/bytes/bytes.d.cts:16
Defined in: [core-sdk/src/bytes/bytes.ts:68](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/bytes/bytes.ts#L68)

Hashes `bytes` with keccak256 and wraps the 32-byte digest.

Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/ChunkBuilder.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Class: ChunkBuilder

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:8
Defined in: [core-sdk/src/chunk/splitter.ts:16](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L16)

A chunk (up to 4096 bytes of payload) being filled in by a ChunkSplitter,
before it's sealed. Unlike the immutable CAC [Chunk](../interfaces/Chunk.md), this is a
Expand All @@ -12,7 +12,7 @@ mutable buffer - only `hash()`/`encryptedHash()`/`build()` finalize it.

> **new ChunkBuilder**(`span?`): `ChunkBuilder`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:11
Defined in: [core-sdk/src/chunk/splitter.ts:20](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L20)

#### Parameters

Expand All @@ -30,23 +30,23 @@ Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts

> **span**: `bigint`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:9
Defined in: [core-sdk/src/chunk/splitter.ts:17](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L17)

***

### writer

> **writer**: `Uint8ArrayWriter`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:10
Defined in: [core-sdk/src/chunk/splitter.ts:18](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L18)

## Methods

### build()

> **build**(): `Uint8Array`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:15
Defined in: [core-sdk/src/chunk/splitter.ts:28](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L28)

Returns the raw chunk bytes: 8-byte span || 4096-byte payload buffer.

Expand All @@ -60,7 +60,7 @@ Returns the raw chunk bytes: 8-byte span || 4096-byte payload buffer.

> **encryptedHash**(`key?`): `object`

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:24
Defined in: [core-sdk/src/chunk/splitter.ts:43](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L43)

Encrypts this chunk with `key` (generating a random one if omitted) and
returns the resulting address alongside the key used.
Expand Down Expand Up @@ -89,7 +89,7 @@ returns the resulting address alongside the key used.

> **hash**(): [`Reference`](Reference.md)

Defined in: bee-js/node\_modules/@ethersphere/core-sdk/dist/chunk/splitter.d.cts:19
Defined in: [core-sdk/src/chunk/splitter.ts:35](https://github.com/ethersphere/core-sdk/blob/96273dfdbc1c6dec040d5aa6df29834e14e33eff/src/chunk/splitter.ts#L35)

Computes the unencrypted BMT address of this chunk.

Expand Down
Loading
Loading