libp2p
    Preparing search index...

    Interface StreamHandlerOptions

    An object that contains an AbortSignal as the optional signal property.

    const controller = new AbortController()

    aLongRunningOperation({
      signal: controller.signal
    })

    // later

    controller.abort
    interface StreamHandlerOptions {
        force?: true;
        maxInboundStreams?: number;
        maxOutboundStreams?: number;
        middleware?: StreamMiddleware[];
        runOnLimitedConnection?: boolean;
        signal?: AbortSignal;
    }

    Hierarchy (View Summary)

    Index

    Properties

    force? maxInboundStreams? maxOutboundStreams? middleware? runOnLimitedConnection? signal?

    Properties

    force?: true

    If true, and a handler is already registered for the specified protocol(s), the existing handler will be discarded.

    maxInboundStreams?: number

    How many incoming streams can be open for this protocol at the same time on each connection

    32
    maxOutboundStreams?: number

    How many outgoing streams can be open for this protocol at the same time on each connection

    64
    middleware?: StreamMiddleware[]

    Middleware allows accessing stream data outside of the stream handler

    runOnLimitedConnection?: boolean

    Opt-in to running over connections with limits on how much data can be transferred or how long it can be open for.

    signal?: AbortSignal

    Settings

    Member Visibility

    On This Page

    Properties