libp2p
    Preparing search index...

    Class PeerQueue<JobReturnType, JobOptions>

    Extends Queue to add support for querying queued jobs by peer id

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    concurrency: number
    maxSize: number

    Accessors

    Methods

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • The dispatchEvent() method of the EventTarget sends an Event to the object, (synchronously) invoking the affected event listeners in the appropriate order. The normal event processing rules (including the capturing and optional bubbling phase) also apply to events dispatched manually with dispatchEvent().

      MDN Reference

      Parameters

      Returns boolean

    • Parameters

      • type: string

      Returns number

    • The difference with .onEmpty is that .onIdle guarantees that all work from the queue has finished. .onEmpty merely signals that the queue is empty, but it could mean that some promises haven't completed yet.

      Parameters

      Returns Promise<void>

      A promise that settles when the queue becomes empty, and all promises have completed; queue.size === 0 && queue.pending === 0.

    • Parameters

      Returns Promise<void>

      A promise that settles when the queue size is less than the given limit: queue.size < limit.

      If you want to avoid having the queue grow beyond a certain size you can await queue.onSizeLessThan() before adding a new item.

      Note that this only limits the number of items waiting to start. There could still be up to concurrency jobs already running that this call does not include in its calculation.