Class WebSocketAdvertiser

Handler that advertises a WebSocket through the Updates-Via header.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

socketUrl: string

Methods

  • Checks if the input can be handled by this class. If it cannot handle the input, rejects with an error explaining why.

    Parameters

    Returns Promise<void>

    A promise resolving if the input can be handled, rejecting with an Error if not.

  • Handles the given input. This may only be called if canHandle did not reject. When unconditionally calling both in sequence, consider handleSafe instead.

    Parameters

    • __namedParameters: {
          response: ServerResponse;
      }

      Input that needs to be handled.

      • response: ServerResponse

    Returns Promise<void>

    A promise resolving when handling is finished.