# event

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

function exported by @mwillbanks/tuil-events.



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

## function [#function]

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

```ts
export function event<TPayload>(
  definition: EventDefinition<TPayload> = {},
): EventDefinition<TPayload>;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member       | Type                        | Required | Description                                                     | Related types                                                             |
| ------------ | --------------------------- | -------- | --------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `definition` | `EventDefinition<TPayload>` | No       | Supplies the `definition` value as `EventDefinition<TPayload>`. | [`EventDefinition`](/tuil/docs/reference/packages/events/api/event-definition) |

## Returns [#returns]

`EventDefinition<TPayload>` — Returns a value that satisfies `EventDefinition<TPayload>`.

Related types: [`EventDefinition`](/tuil/docs/reference/packages/events/api/event-definition)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`EventDefinition`](/tuil/docs/reference/packages/events/api/event-definition)

## 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)