Function: openStream()

openStream(secretKey, source, options?): AsyncGenerator<Uint8Array<ArrayBufferLike>>

Defined in: stream.ts:233

Decrypts a stream produced by sealStream. The source may deliver the bytes in pieces of any size. Yields the plaintext chunk by chunk. It throws on the first chunk that fails; a truncated, extended, reordered or modified stream never completes silently.

Parameters

secretKey

SecretKey

source

ByteSource

options?

OpenStreamOptions = {}

Returns

AsyncGenerator<Uint8Array<ArrayBufferLike>>

Throws

on authentication failure; MalformedCiphertextError for a malformed prelude or frame.