Skip to content

Class: StreamOpener ​

Defined in: stream.ts:117

Low-level opener: feed the ciphertext of each chunk in order, saying whether it is the last one. A failure ends the stream.

Implements ​

  • Disposable

Properties ​

chunkSize ​

readonly chunkSize: number

Defined in: stream.ts:119

Methods ​

[dispose]() ​

[dispose](): void

Defined in: stream.ts:143

Returns ​

void

Implementation of ​

Disposable.[dispose]


free() ​

free(): void

Defined in: stream.ts:140

Returns ​

void


open() ​

open(ciphertext, last): Uint8Array

Defined in: stream.ts:136

Opens the next chunk.

Parameters ​

ciphertext ​

Uint8Array

last ​

boolean

Returns ​

Uint8Array

Throws ​

if it was modified, reordered, dropped, truncated, or the key or AAD is wrong.


start() ​

static start(secretKey, header, options?): StreamOpener

Defined in: stream.ts:126

Parameters ​

secretKey ​

SecretKey

Uint8Array

options? ​

OpenStreamOptions = {}

Returns ​

StreamOpener

Apache-2.0.