Search documentation

Search by topic, API name, or import path.

GitHub ↗

variable / @typed/fx

Fx.FxTypeId

Runtime symbol carried by every Fx implementation.

Package version
2.0.0-beta.7
Category
Runtime inspection
Since
1.0.0
Member of
Fx

Import

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

Access Fx.FxTypeId through the imported Fx 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 FxTypeId: unique symbol;
export type FxTypeId = typeof FxTypeId;

Why

A global symbol lets independent packages recognize an Fx structurally without invoking it or relying on a concrete implementation class.

Ownership and lifetime

Reading or comparing the symbol starts no work and acquires no resources.

Examples

import { FxTypeId, succeed } from "@typed/fx/Fx"

const carriesFxProtocol = FxTypeId in succeed("ready")

Other public imports

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

Source