effx
API reference@effx/ir

StableId

API reference for @effx/ir/StableId

StableId.ts overview


Exports Grouped by Category


utils

Kind (type alias)

Signature

type Kind = "schema" | "model" | "service" | "operation" | "group" | "capability" | "focus" | "exposure" | "ext"

StableId

Signature

declare const StableId: Schema.brand<Schema.String, "effx/StableId">

StableId (type alias)

Signature

type StableId = typeof StableId.Type

isStableId

Signature

declare const isStableId: <I>(input: I) => input is I & string & Brand<"effx/StableId">

kindOf

Signature

declare const kindOf: (id: StableId) => string

make

Builds an id from parts; throws only on malformed input (programmer error).

Signature

declare const make: (kind: Kind, name: string) => StableId

nameOf

Signature

declare const nameOf: (id: StableId) => string

pattern

StableId := kind ":" name; see docs/specs/0001-compiler-kernel.md. kind is lowercase; name may contain . / : - _ $.

Signature

declare const pattern: RegExp

On this page