Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BiStream

Read / write stream

Hierarchy

Index

Properties

Methods

Properties

Readonly ended

ended: boolean

Indicate current stream is ended or not

Methods

close

  • close(): void

read

  • read(buffer: Uint8Array): Promise<null | number>

  • Read data up to size bytes.

    Parameters

    • buffer: Uint8Array

      Read buffer

    Returns Promise<null | number>

    Read size or null on ended

write

  • write(data: Uint8Array): Promise<number>

  • Write data. Written size is always same as data.byteLength, unless the stream ends during writing.

    Parameters

    • data: Uint8Array

    Returns Promise<number>

    Written size

Generated using TypeDoc