tuil
ReferencePackages@mwillbanks/tuil-coreAPI

deleteOnDispose

function exported by @mwillbanks/tuil-core.

View rawEdit

function

Public function exported by @mwillbanks/tuil-core.

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

Members

This declaration has no public members.

Parameters

MemberTypeRequiredDescriptionRelated types
collectionPick<Set<T>, "delete">YesSupplies the collection value as Pick<Set<T>, "delete">.
valueTYesSupplies the value value as T.
onDelete() => voidNoSupplies the onDelete value as () => void.

Returns

Disposer — Returns a value that satisfies Disposer.

Related types: Disposer

Throws

No thrown errors are documented for this declaration.

Source

View the secondary source reference

Package

@mwillbanks/tuil-core

On this page