VoidEvent

Defined in: packages/async/src/events/void-event.ts:25

A no-payload event that can be emitted and waited upon — the Event<T> sibling for signals that carry no data (e.g. a resize notification).

Example

  const event = new VoidEvent();

  // Subscriber
  event.subscribe(() => {
    console.log("Event received");
  });

  // Emitter
  event.emit();

  // Waiter
  await event.wait();
  console.log("Waited event received");
  ```;

## Extends

- [`EventDispatcherBase`](EventDispatcherBase.md)\<`never`[]\>

## Implements

- [`IEventDispatcher`](../interfaces/IEventDispatcher.md)\<`never`[]\>

## Constructors

### Constructor

> **new VoidEvent**(): `VoidEvent`

#### Returns

`VoidEvent`

#### Inherited from

[`EventDispatcherBase`](EventDispatcherBase.md).[`constructor`](EventDispatcherBase.md#constructor)

## Methods

### emit()

> **emit**(): `void`

Defined in: packages/async/src/events/void-event.ts:29

#### Returns

`void`

***

### isSubscribed()

> **isSubscribed**(`subscriber`): `boolean`

Defined in: packages/async/src/events/event-dispatcher-base.ts:99

Tests whether a listener is registered.

#### Parameters

##### subscriber

`Callable`\<`never`[]\>

#### Returns

`boolean`

True if the listener is registered, false otherwise.

#### Implementation of

[`IEventDispatcher`](../interfaces/IEventDispatcher.md).[`isSubscribed`](../interfaces/IEventDispatcher.md#issubscribed)

#### Inherited from

[`EventDispatcherBase`](EventDispatcherBase.md).[`isSubscribed`](EventDispatcherBase.md#issubscribed)

***

### subscribe()

> **subscribe**(`subscriber`, `options?`): `Callable` \| `null`

Defined in: packages/async/src/events/event-dispatcher-base.ts:54

Registers a listener function to be called when the event is dispatched.

If the listener is already registered, this method has no effect.

#### Parameters

##### subscriber

`Callable`\<`never`[]\>

##### options?

[`EventDispatcherSubscribeOptions`](../type-aliases/EventDispatcherSubscribeOptions.md)

Optional settings for the subscription.

#### Returns

`Callable` \| `null`

A function that can be called to unsubscribe the listener, or null
  if the listener was already registered.

#### Implementation of

[`IEventDispatcher`](../interfaces/IEventDispatcher.md).[`subscribe`](../interfaces/IEventDispatcher.md#subscribe)

#### Inherited from

[`EventDispatcherBase`](EventDispatcherBase.md).[`subscribe`](EventDispatcherBase.md#subscribe)

***

### unsubscribe()

> **unsubscribe**(`subscriber`): `void`

Defined in: packages/async/src/events/event-dispatcher-base.ts:88

Unregisters a previously registered listener function.

If the listener is not registered, this method has no effect.

#### Parameters

##### subscriber

`Callable`\<`never`[]\>

#### Returns

`void`

#### Implementation of

[`IEventDispatcher`](../interfaces/IEventDispatcher.md).[`unsubscribe`](../interfaces/IEventDispatcher.md#unsubscribe)

#### Inherited from

[`EventDispatcherBase`](EventDispatcherBase.md).[`unsubscribe`](EventDispatcherBase.md#unsubscribe)

***

### wait()

> **wait**(`options?`): `Promise`\<`never`[]\>

Defined in: packages/async/src/events/event-dispatcher-base.ts:103

Waits for the next occurrence of the event, optionally matching a
predicate.

This is a convenience method that subscribes to the dispatcher, waits for
the next event that matches the predicate (if provided), and then
unsubscribes automatically.

#### Parameters

##### options?

[`EventDispatcherWaitOptions`](../type-aliases/EventDispatcherWaitOptions.md)\<`never`[]\>

Optional settings including predicate and abort signal.

#### Returns

`Promise`\<`never`[]\>

A promise that resolves with the next event arguments as an array.

#### Implementation of

[`IEventDispatcher`](../interfaces/IEventDispatcher.md).[`wait`](../interfaces/IEventDispatcher.md#wait)

#### Inherited from

[`EventDispatcherBase`](EventDispatcherBase.md).[`wait`](EventDispatcherBase.md#wait)