Class CborMapDecodedStream

A ReadableStream that wraps the decoded CBOR "Map". RFC 8949 - Concise Binary Object Representation (CBOR)

Instances of this class is created from CborSequenceDecoderStream. This class is not designed for you to create instances of it yourself. It is merely a way for you to validate the type being returned.

Example: Usage

import { assert, assertEquals } from "@std/assert";
import {
  CborMapDecodedStream,
  CborMapEncoderStream,
  CborSequenceDecoderStream,
} from "@std/cbor";

const rawMessage: Record<string, number> = {
  a: 0,
  b: 1,
  c: 2,
  d: 3,
};

for await (
  const value of ReadableStream.from(Object.entries(rawMessage))
    .pipeThrough(new CborMapEncoderStream)
    .pipeThrough(new CborSequenceDecoderStream())
) {
  assert(value instanceof CborMapDecodedStream);
  for await (const [k, v] of value) {
    assertEquals(rawMessage[k], v);
  }
}
Hierarchy

Constructors

constructor

Properties

locked

Methods

cancel getReader pipeThrough pipeTo tee

Constructors

constructor

Properties

Readonlylocked

locked: boolean

MDN Reference

Methods

cancel

  • cancel(reason?): Promise<void>

  • MDN Reference

    Parameters

    • Optionalreason: any

    Returns Promise<void>

getReader

  • getReader(options): ReadableStreamBYOBReader

  • MDN Reference

    Parameters

    • options: {
          mode: "byob";
      }
      • mode: "byob"

    Returns ReadableStreamBYOBReader

  • getReader(): ReadableStreamDefaultReader<CborMapStreamOutput>

  • Returns ReadableStreamDefaultReader<CborMapStreamOutput>

  • getReader(options?): ReadableStreamReader<CborMapStreamOutput>

  • Parameters

    • Optionaloptions: ReadableStreamGetReaderOptions

    Returns ReadableStreamReader<CborMapStreamOutput>

pipeThrough

  • pipeThrough<T>(transform, options?): ReadableStream<T>

  • MDN Reference

    Type Parameters

    • T

    Parameters

    Returns ReadableStream<T>

pipeTo

  • pipeTo(destination, options?): Promise<void>

  • MDN Reference

    Parameters

    Returns Promise<void>

tee

Settings

Member Visibility

On This Page

Constructors
Properties
Methods