Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WaitHandle Abstract

An object that waits for exclusive access to another object.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Protected constructor

  • Initializes the base WaitHandle.

    Parameters

    • Optional isSignaled: boolean

      The initial signal state of the object.

    Returns WaitHandle

Properties

Private #private

#private: any

Private await

await: any

Protected isSignaled

isSignaled: boolean

Methods

Protected notify

  • notify(count: number): number

  • Notifies a given number of awaiting coroutines that are waiting on the current wait handle.

    Parameters

    • count: number

      The number of awaiting coroutines to notify.

    Returns number

    The number of awaiting coroutines that were notified.

wait

  • wait(abortSignal?: AbortSignal): Promise<void>

  • Waits for the current {@link @aitHandle} to receive a signal.

    Parameters

    • Optional abortSignal: AbortSignal

      An optional AbortSignal that will abort the current wait operation.

    Returns Promise<void>

    A Promise that resolves when the current WaitHandle receives a signal.

Generated using TypeDoc