# EventEmitOptions

Source: /tuil/docs/reference/packages/events/api/event-emit-options
Locale: en

interface exported by @mwillbanks/tuil-events.



{/* Generated by tooling/docs/generate-reference.ts. */}

## interface [#interface]

Public interface exported by `@mwillbanks/tuil-events`.

```ts
export interface EventEmitOptions {
  readonly source?: EventSource;
  readonly target?: EventTarget;
  readonly metadata?: Readonly<Record<string, unknown>>;
  readonly priority?: EventPriority;
  readonly path?: readonly string[];
}
```

## Members [#members]

| Member     | Type                                             | Required | Description                                                                               | Related types                                                         |
| ---------- | ------------------------------------------------ | -------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| `source`   | `EventSource \| undefined`                       | No       | The `source` member uses the `EventSource \| undefined` contract.                         | [`EventSource`](/tuil/docs/reference/packages/events/api/event-source)     |
| `target`   | `EventTarget \| undefined`                       | No       | The `target` member uses the `EventTarget \| undefined` contract.                         | [`EventTarget`](/tuil/docs/reference/packages/events/api/event-target)     |
| `metadata` | `Readonly<Record<string, unknown>> \| undefined` | No       | The `metadata` member uses the `Readonly<Record<string, unknown>> \| undefined` contract. | —                                                                     |
| `priority` | `EventPriority \| undefined`                     | No       | The `priority` member uses the `EventPriority \| undefined` contract.                     | [`EventPriority`](/tuil/docs/reference/packages/events/api/event-priority) |
| `path`     | `readonly string[] \| undefined`                 | No       | The `path` member uses the `readonly string[] \| undefined` contract.                     | —                                                                     |

## Parameters [#parameters]

This declaration has no public members.

## Returns [#returns]

This declaration does not return a value.

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`EventPriority`](/tuil/docs/reference/packages/events/api/event-priority)
* [`EventSource`](/tuil/docs/reference/packages/events/api/event-source)
* [`EventTarget`](/tuil/docs/reference/packages/events/api/event-target)

## Source [#source]

[View the secondary source reference](https://github.com/mwillbanks/tuil/blob/main/packages/events/src/index.ts)

## Package [#package]

[@mwillbanks/tuil-events](/tuil/docs/reference/packages/events)