web-serial-rxjs API Documentation
    Preparing search index...

    Interface SerialSessionFeatureOptions

    Library-specific options for createSerialSession that are not passed to W3C port.open.

    interface SerialSessionFeatureOptions {
        filters?: SerialPortFilter[];
        lineBuffer?: LineBufferOptions;
        receiveReplay?: SerialSessionReceiveReplayOptions;
        terminalBuffer?: TerminalBufferOptions;
    }

    Hierarchy (View Summary)

    Index
    filters? lineBuffer? receiveReplay? terminalBuffer?
    filters?: SerialPortFilter[]

    Filters for port selection when requesting a port.

    When specified, the port selection dialog will only show devices matching these filters. Each filter can specify usbVendorId and/or usbProductId.

    lineBuffer?: LineBufferOptions

    Limits for the incomplete line tail held by SerialSession.lines$ framing. When exceeded, leading characters are discarded and a non-fatal SerialErrorCode.LINE_BUFFER_OVERFLOW is emitted on SerialSession.errors$.

    { maxChars: 1048576 } (see DEFAULT_SERIAL_SESSION_OPTIONS)

    Issue #371

    receiveReplay?: SerialSessionReceiveReplayOptions

    Optional receive replay: retain recent decoded text chunks so late subscribers to SerialSession.receiveReplay$ can read buffered data while a connection is active. Does not change SerialSession.receive$.

    { enabled: false, bufferSize: 512 } (see DEFAULT_SERIAL_SESSION_OPTIONS)

    terminalBuffer?: TerminalBufferOptions

    Limits for SerialSession.terminalText$ display memory. Oldest completed lines and leading characters are dropped when exceeded.

    { maxLines: 10000, maxChars: 1048576 } (see DEFAULT_SERIAL_SESSION_OPTIONS)

    Issue #370

    Settings
    Member Visibility

    On This Page
    Properties