Variable createBufferedNetworkEventEmitter`Const` `Experimental`

createBufferedNetworkEventEmitter: <EventType extends NetworkEventTypes>(
    eventType: EventType,
    documentation?: SingleNotificationDocumentation,
    options?: {
        bufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>;
    },
) => {
    dispose: () => void;
    emit: (event: NetworkEvents[EventType]) => void;
    registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;
}

Synchronously create a buffered emitter for a single-source network event. Use this for events that may be emitted before the network emitter finishes registering — e.g. from a UI handler or a command that can fire during extension activation, where the eager createNetworkEventEmitterAsync would leave a module-level emitter undefined.

The returned emit is usable immediately. Emits made before central registration completes are buffered per options.bufferStrategy and flushed once registration succeeds; after that emit passes straight through. If registration fails, buffered events are dropped (with a warning) and registeredEmitter rejects so the caller can respond.

Type declaration

- <EventType extends NetworkEventTypes>(
      eventType: EventType,
      documentation?: SingleNotificationDocumentation,
      options?: {
          bufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>;
      },
  ): {
      dispose: () => void;
      emit: (event: NetworkEvents[EventType]) => void;
      registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;
  }
- Type Parameters
  - EventType extends NetworkEventTypes
  Parameters
  - eventType: EventType
    A key of NetworkEvents.
  - Optionaldocumentation: SingleNotificationDocumentation
    Optional notification documentation. Carries notification['x-experimental']: true to mark the event as experimental.
  - Optionaloptions: { bufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]> }
    - OptionalbufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>
      How to buffer pre-registration emits. Defaults to 'queue'.
  Returns {
      dispose: () => void;
      emit: (event: NetworkEvents[EventType]) => void;
      registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;
  }
  emit (usable immediately), registeredEmitter (resolves to the underlying emitter, or rejects if registration failed), and dispose.

Variable createBufferedNetworkEventEmitter`Const` `Experimental`

Type declaration

Type Parameters

Parameters

`Optional`bufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>

Returns {
    dispose: () => void;
    emit: (event: NetworkEvents[EventType]) => void;
    registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;
}

Settings

Variable createBufferedNetworkEventEmitterConst Experimental

Type declaration

Type Parameters

Parameters

OptionalbufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>

Returns { dispose: () => void; emit: (event: NetworkEvents[EventType]) => void; registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;}

Settings

Variable createBufferedNetworkEventEmitter`Const` `Experimental`

`Optional`bufferStrategy?: NetworkEventBufferStrategy<NetworkEvents[EventType]>

Returns {
dispose: () => void;
emit: (event: NetworkEvents[EventType]) => void;
registeredEmitter: Promise<PlatformEventEmitter<NetworkEvents[EventType]>>;
}