variable / @typed/fx

RefIterable.head

Get the first element of a RefIterable as a Filtered.

Package version
2.0.0-beta.7
Category
Optional queries
Since
1.18.0
Member of
RefIterable

Import

import { RefIterable } from "@typed/fx";

Access RefIterable.head through the imported RefIterable 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 const head: <A, E, R>(ref: RefIterable<A, E, R>) => RefSubject.Filtered<A, E, R>;

Why

Models the possibly absent result of head as Filtered state, so absence stays explicit while later source versions can make a value available.

Ownership and lifetime

The head view retains no independent value. Its Effect read fails with NoSuchElement while absent; the observing Scope owns and finalizes its Fx subscription.

Other public imports

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

Source