Interface CBORStream<Stream>

Convenience methods for working with CBOR streams

interface CBORStream<Stream = unknown> {
    read<T>(options?: AbortOptions): Promise<T>;
    unwrap(): Stream;
    write<T>(data: T, options?: AbortOptions): Promise<void>;
    writeV<T>(input: T[], options?: AbortOptions): Promise<void>;
}

Type Parameters

Stream = unknown

Index

Methods

read unwrap write writeV

Methods

read

read<T>(options?: AbortOptions): Promise<T>
Read the next length-prefixed byte array from the stream and decode it as CBOR
Type Parameters
- T
Parameters
- Optionaloptions: AbortOptions
Returns Promise<T>
- Defined in index.ts:39

unwrap

unwrap(): Stream
Returns the underlying stream

Returns Stream
- Defined in index.ts:54

write

write<T>(data: T, options?: AbortOptions): Promise<void>
Encode the passed object as a CBOR message and write it's length-prefixed bytes to the stream
Type Parameters
- T
Parameters
- data: T
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in index.ts:44

writeV

writeV<T>(input: T[], options?: AbortOptions): Promise<void>
Encode the passed objects as CBOR messages and write their length-prefixed bytes to the stream as a single write
Type Parameters
- T
Parameters
- input: T[]
- Optionaloptions: AbortOptions
Returns Promise<void>
- Defined in index.ts:49