function / @typed/ui/index

Collection.unregister

Removes every registered item with the supplied id and retains the remaining order.

Learn this UI primitive →

Package version
1.0.0-beta.7
Category
Item registration
Since
1.0.0
Member of
Collection

Import

import { Collection } from "@typed/ui/index";

Access Collection.unregister through the imported Collection export. Its declaration below describes the member.

This public exposure is a re-export. Its import path is supported; declaration documentation is shared with the other public exposures below.

Signatures

export declare function unregister<Value, Element extends object, E, R>(collection: RefSubject.RefSubject<State<Value, Element>, E, R>, id: string): Effect.Effect<void, E, R>;

Why

The operation exposes Collection’s transition directly so callers can compose it in Effect programs and native event handlers.

Ownership and lifetime

The returned Effect performs the update or DOM side effect only when run, preserves the declared error and service channels, and retains no resources after completion.

Example

Import with import { unregister } from "@typed/ui/Collection"; Extend the Collection.makeState runnable setup. Inside the linked Effect program first register "save", run yield* unregister(collection, "save"), then read the collection to observe that only the matching id was removed.

Other public imports

These import paths expose the same declaration. Each page retains its own public name and signature.

Source