# deleteOnDispose

Source: /tuil/docs/reference/packages/core/api/delete-on-dispose
Locale: en

function exported by @mwillbanks/tuil-core.



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

## function [#function]

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

```ts
export function deleteOnDispose<T>(
  collection: Pick<Set<T>, "delete">,
  value: T,
  onDelete?: () => void,
): Disposer;
```

## Members [#members]

This declaration has no public members.

## Parameters [#parameters]

| Member       | Type                     | Required | Description                                                  | Related types |
| ------------ | ------------------------ | -------- | ------------------------------------------------------------ | ------------- |
| `collection` | `Pick<Set<T>, "delete">` | Yes      | Supplies the `collection` value as `Pick<Set<T>, "delete">`. | —             |
| `value`      | `T`                      | Yes      | Supplies the `value` value as `T`.                           | —             |
| `onDelete`   | `() => void`             | No       | Supplies the `onDelete` value as `() => void`.               | —             |

## Returns [#returns]

`Disposer` — Returns a value that satisfies `Disposer`.

Related types: [`Disposer`](/tuil/docs/reference/packages/core/api/disposer)

## Throws [#throws]

No thrown errors are documented for this declaration.

## Related types [#related-types]

* [`Disposer`](/tuil/docs/reference/packages/core/api/disposer)

## Source [#source]

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

## Package [#package]

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