Class CborByteDecodedStream

A ReadableStream that wraps the decoded CBOR "Byte String". 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 { concat } from "@std/bytes";
import {
  CborByteDecodedStream,
  CborByteEncoderStream,
  CborSequenceDecoderStream,
} from "@std/cbor";

const rawMessage = new Uint8Array(100);

for await (
  const value of ReadableStream.from([rawMessage])
    .pipeThrough(new CborByteEncoderStream())
    .pipeThrough(new CborSequenceDecoderStream())
) {
  assert(value instanceof Uint8Array || value instanceof CborByteDecodedStream);
  if (value instanceof CborByteDecodedStream) {
    assertEquals(concat(await Array.fromAsync(value)), new Uint8Array(100));
  } else assertEquals(value, new Uint8Array(100));
}
Hierarchy
  • ReadableStream<Uint8Array>
    • CborByteDecodedStream

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<Uint8Array>

  • Returns ReadableStreamDefaultReader<Uint8Array>

  • getReader(options?): ReadableStreamReader<Uint8Array>

  • Parameters

    • Optionaloptions: ReadableStreamGetReaderOptions

    Returns ReadableStreamReader<Uint8Array>

pipeThrough

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

  • MDN Reference

    Type Parameters

    • T

    Parameters

    • transform: ReadableWritablePair<T, Uint8Array>
    • Optionaloptions: StreamPipeOptions

    Returns ReadableStream<T>

pipeTo

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

  • MDN Reference

    Parameters

    • destination: WritableStream<Uint8Array>
    • Optionaloptions: StreamPipeOptions

    Returns Promise<void>

tee

  • tee(): [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]

  • MDN Reference

    Returns [ReadableStream<Uint8Array>, ReadableStream<Uint8Array>]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods