ixfx
    Preparing search index...

    Class StringWriteBuffer

    Buffers a queue of strings.

    When text is queued via add, it is chopped up into chunks and sent in serial to the dataHandler function. Data is processed at a set rate, by default 10ms.

    const dataHandler = (data:string) => {
     // Do something with queued data.
     // eg. send to serial port
    }

    // Create a buffer with a chunk size of 100 characters
    const b = new StringWriteBuffer(dataHandler, { chunkSize: 100 });
    b.add('some text'); // Write to buffer
    // dataHandler will be called until queued data is empty

    It's also possible to get the buffer as a WritableStream:

    const dataHandler = (data:string) => { ... }
    const b = new StringWriteBuffer(dataHandler, 100);
    const s = b.writable();

    Other functions:

    b.close(); // Close buffer
    b.clear(); // Clear queued data, but don't close anything

    Constructors

    constructor

    Properties

    chunkSize closed paused queue stream writer

    Accessors

    isClosed

    Methods

    add clear close onWrite writable

    Constructors

    constructor

    Properties

    chunkSize

    chunkSize: number

    closed

    closed: boolean = false

    paused

    paused: boolean = false

    queue

    queue: QueueMutable<string> = ...

    stream

    stream: undefined | WritableStream<string>

    writer

    writer: Continuously

    Accessors

    isClosed

    • get isClosed(): boolean

      Returns true if close has been called.

      Returns boolean

    Methods

    add

    • add(stringToQueue: string): void

      Adds some queued data to send. Longer strings are automatically chunked up according to the buffer's settings.

      Throws an error if close has been called.

      Parameters

      • stringToQueue: string

      Returns void

    clear

    • clear(): void

      Clear queued data.

      Throws an error if close has been called.

      Returns void

    close

    • close(): Promise<void>

      Close writer (async)

      Returns Promise<void>

    onWrite

    • onWrite(): Promise<boolean>

      Run in a continunously loop to process queued data

      Returns Promise<boolean>

      False if queue is empty and loop should stop. True if it shoud continue.

    writable

    • writable(): WritableStream<string>

      Gets the buffer as a writable stream.

      Do not close stream directly, use .close on this class instead.

      Throws an error if .close() has been called.

      Returns WritableStream<string>

      Underlying stream

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods