cairn

Import

Import

import * as api from "@fungi.computer/cairn";

Exports

Kind	Export	Description
constconstant	identifierDefinitionSchema	Validate one bounded version 1 family declaration.
constconstant	identifierCandidateSchema	Decode a wire candidate before calling a typed string codec.
constconstant	ALPHABET	URL-safe lowercase alphabet used for opaque identifiers.
constconstant	SHORT	Identifier size for compact, non-security-sensitive labels.
constconstant	DEFAULT	Default identifier size.
constconstant	LONG	Identifier size for callers that require additional collision resistance.
fnfunction	nanoid()	Generate a raw opaque identifier through the runtime-selected nanoid implementation.

identifierDefinitionSchemaconstconstant

Signature

const identifierDefinitionSchema: ZodObject<
  {
    family: ZodString;
    version: ZodLiteral<1>;
    kinds: ZodRecord<
      ZodString,
      ZodObject<
        {
          prefix: ZodString;
        },
        $strip
      >
    >;
  },
  $strip
>;

Validate one bounded version 1 family declaration.

---

identifierCandidateSchemaconstconstant

Signature

const identifierCandidateSchema: ZodString;

Decode a wire candidate before calling a typed string codec.

---

ALPHABETconstconstant

Signature

const ALPHABET: "abcdefghijklmnopqrstuvwxyz0123456789" =
  "abcdefghijklmnopqrstuvwxyz0123456789";

URL-safe lowercase alphabet used for opaque identifiers.

---

SHORTconstconstant

Signature

const SHORT: 8 = 8;

Identifier size for compact, non-security-sensitive labels.

---

DEFAULTconstconstant

Signature

const DEFAULT: 21 = 21;

Default identifier size.

---

LONGconstconstant

Signature

const LONG: 32 = 32;

Identifier size for callers that require additional collision resistance.

nanoid()fnfunction

Signature

function nanoid(length?): string;

Generate a raw opaque identifier through the runtime-selected nanoid implementation.

Parameters

Parameter	Type	Default value	Description
length	number	DEFAULT	Requested output size; supply a bounded nonnegative integer unless accepting upstream/runtime-specific behavior.

Returns

string

A lowercase alphanumeric identifier.

Remarks

This legacy helper accepts trusted sizing-policy inputs; CPU and output scale with the requested size. Finite sizing values delegate exactly to the runtime-selected upstream implementation and may be runtime-specific. Callers should supply a bounded nonnegative integer unless they consciously accept upstream/runtime-specific behavior. Only positive and negative infinity receive Cairn’s fixed bounded RangeError. For new durable identifiers, use defineIdFamily.

Throws

If length is positive or negative infinity. Other finite-size exceptions follow the upstream runtime behavior.

References

CairnDefinitionError

Re-exports CairnDefinitionError

---

CairnGenerationError

Re-exports CairnGenerationError

---

defineIdFamily

Re-exports defineIdFamily

---

CairnId

Re-exports CairnId

---

IdCodec

Re-exports IdCodec

---

IdFamily

Re-exports IdFamily

---

IdKindDefinition

Re-exports IdKindDefinition

---

IdOf

Re-exports IdOf

---

IdParseError

Re-exports IdParseError

---

IdParseResult

Re-exports IdParseResult

---

ADJECTIVES

Re-exports ADJECTIVES

---

NOUNS

Re-exports NOUNS

---

words

Re-exports words

---

replayKey

Re-exports replayKey

---

deterministicReplayKey

Re-exports deterministicReplayKey

---

correlationKey

Re-exports correlationKey

---

createCorrelationSequence

Re-exports createCorrelationSequence

---

ReplayKey

Re-exports ReplayKey

---

CorrelationKey

Re-exports CorrelationKey