Class Secret

A secret to be split into shares.

Index

Methods

new len isEmpty getData asRef equals clone

Methods

`Static`new

new(data: string | Uint8Array<ArrayBufferLike>): Secret
Creates a new Secret instance with the given data.
Parameters
- data: string | Uint8Array<ArrayBufferLike>
  The secret data to be split into shares.
Returns Secret
A new Secret instance.

Throws
SSKRError if the length of the secret is less than MIN_SECRET_LEN, greater than MAX_SECRET_LEN, or not even.
- Defined in secret.ts:24

len

len(): number
Returns the length of the secret.

Returns number
- Defined in secret.ts:44

isEmpty

isEmpty(): boolean
Returns true if the secret is empty.

Returns boolean
- Defined in secret.ts:51

getData

getData(): Uint8Array
Returns a reference to the secret data.

Returns Uint8Array
- Defined in secret.ts:58

asRef

asRef(): Uint8Array
Returns the secret data as a Uint8Array.

Returns Uint8Array
- Defined in secret.ts:65

equals

equals(other: Secret): boolean
Check equality with another Secret.
Parameters
- other: Secret
Returns boolean
- Defined in secret.ts:72

clone

clone(): Secret
Clone the secret.

Returns Secret
- Defined in secret.ts:87