Class CborTextDecodedStream

A ReadableStream that wraps the decoded CBOR "Text 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 {
  CborSequenceDecoderStream,
  CborTextDecodedStream,
  CborTextEncoderStream,
} from "@std/cbor";

const rawMessage = "a".repeat(100);

for await (
  const value of ReadableStream.from([rawMessage])
    .pipeThrough(new CborTextEncoderStream())
    .pipeThrough(new CborSequenceDecoderStream())
) {
  assert(typeof value === "string" || value instanceof CborTextDecodedStream);
  if (value instanceof CborTextDecodedStream) {
    assertEquals((await Array.fromAsync(value)).join(""), rawMessage);
  } else assertEquals(value, rawMessage);
}
Hierarchy
  • ReadableStream<string>
    • CborTextDecodedStream

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

  • Returns ReadableStreamDefaultReader<string>

  • getReader(options?): ReadableStreamReader<string>

  • Parameters

    • Optionaloptions: ReadableStreamGetReaderOptions

    Returns ReadableStreamReader<string>

pipeThrough

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

  • MDN Reference

    Type Parameters

    • T

    Parameters

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

    Returns ReadableStream<T>

pipeTo

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

  • MDN Reference

    Parameters

    • destination: WritableStream<string>
    • Optionaloptions: StreamPipeOptions

    Returns Promise<void>

tee

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

  • MDN Reference

    Returns [ReadableStream<string>, ReadableStream<string>]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods