variable / @typed/fx

RefDateTime.format

Format the current state of a RefDateTime.

Package version
2.0.0-beta.13
Category
Date formatting
Since
1.18.0
Member of
RefDateTime

Import

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

Access RefDateTime.format through the imported RefDateTime 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 format: {
    (options?: Intl.DateTimeFormatOptions & {
        readonly locale?: string | undefined;
    }): <E, R>(ref: RefDateTime<E, R>) => RefSubject.Computed<string, E, R>;
    <E, R>(ref: RefDateTime<E, R>, options?: Intl.DateTimeFormatOptions & {
        readonly locale?: string | undefined;
    }): RefSubject.Computed<string, E, R>;
};

Why

Format the current state of a RefDateTime. The operation remains attached to the RefSubject’s versioned state boundary.

Ownership and lifetime

The format view retains no independent state. An Effect read samples the source once; Fx observation follows later pushes and its observing Scope owns subscription cleanup.

Other public imports

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

Source