# EventDefinition

Source: /tuil/docs/reference/packages/events/api/event-definition
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 EventDefinition<TPayload> {
  readonly redact?: (payload: TPayload) => unknown;
}
```

## Members [#members]

| Member   | Type                                            | Required | Description                                                                            | Related types |
| -------- | ----------------------------------------------- | -------- | -------------------------------------------------------------------------------------- | ------------- |
| `redact` | `((payload: TPayload) => unknown) \| undefined` | No       | The `redact` member uses the `((payload: TPayload) => unknown) \| 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]

No package-local related types.

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