node-dextrin - v0.1.0
    Preparing search index...

    Variable export=

    "export=": {
        decode: (
            text: string,
            opts?: { registry?: export=; trusted?: boolean },
        ) => unknown;
        decodeBinary: (
            bytes: Uint8Array<ArrayBufferLike>,
            opts?: { registry?: export=; trusted?: boolean },
        ) => unknown;
        DXNBytes: typeof export=;
        DXNChar: typeof export=;
        DXNCustomTag: typeof export=;
        DXNDate: typeof export=;
        DXNDateTime: typeof export=;
        DXNDecimal: typeof export=;
        DXNDuration: typeof export=;
        DXNError: typeof export=;
        DXNKeyword: typeof export=;
        DXNList: typeof export=;
        DXNOrderedMap: typeof export=;
        DXNRational: typeof export=;
        DXNRegex: typeof export=;
        DXNSortedSet: typeof export=;
        DXNStruct: typeof export=;
        DXNSymbol: typeof export=;
        DXNTime: typeof export=;
        DXNTimestamp: typeof export=;
        DXNTuple: typeof export=;
        DXNURI: typeof export=;
        DXNUUID: typeof export=;
        encode: (
            value: unknown,
            opts?: {
                coerce?: boolean;
                indent?: number;
                pretty?: boolean;
                registry?: export=;
                schema?: string;
                validate?: boolean;
            },
        ) => string;
        encodeBinary: (
            value: unknown,
            opts?: {
                coerce?: boolean;
                registry?: export=;
                schema?: string;
                validate?: boolean;
                [k: string]: unknown;
            },
        ) => Buffer<ArrayBufferLike>;
        FileResolver: schema/file-resolver;
        KIND_RANK: Record<string, number>;
        Registry: typeof export=;
        Schema: schema;
        Std: schema/std;
        version: string;
        canonicalKey(value: unknown): string;
        dxnCompare(a: unknown, b: unknown): -1 | 0 | 1;
        dxnEquals(a: unknown, b: unknown): boolean;
        kindOf(value: unknown): string;
    }

    Type Declaration

    • decode: (text: string, opts?: { registry?: export=; trusted?: boolean }) => unknown
    • decodeBinary: (
          bytes: Uint8Array<ArrayBufferLike>,
          opts?: { registry?: export=; trusted?: boolean },
      ) => unknown
    • DXNBytes: typeof export=
    • DXNChar: typeof export=
    • DXNCustomTag: typeof export=
    • DXNDate: typeof export=
    • DXNDateTime: typeof export=
    • DXNDecimal: typeof export=
    • DXNDuration: typeof export=
    • DXNError: typeof export=
    • DXNKeyword: typeof export=
    • DXNList: typeof export=
    • DXNOrderedMap: typeof export=
    • DXNRational: typeof export=
    • DXNRegex: typeof export=
    • DXNSortedSet: typeof export=
    • DXNStruct: typeof export=
    • DXNSymbol: typeof export=
    • DXNTime: typeof export=
    • DXNTimestamp: typeof export=
    • DXNTuple: typeof export=
    • DXNURI: typeof export=
    • DXNUUID: typeof export=
    • encode: (
          value: unknown,
          opts?: {
              coerce?: boolean;
              indent?: number;
              pretty?: boolean;
              registry?: export=;
              schema?: string;
              validate?: boolean;
          },
      ) => string
    • encodeBinary: (
          value: unknown,
          opts?: {
              coerce?: boolean;
              registry?: export=;
              schema?: string;
              validate?: boolean;
              [k: string]: unknown;
          },
      ) => Buffer<ArrayBufferLike>
    • FileResolver: schema/file-resolver
    • KIND_RANK: Record<string, number>
    • Registry: typeof export=
    • Schema: schema
    • Std: schema/std
    • version: string
    • canonicalKey: function
      • A stable string encoding of a DXN value, equal for and only for dxnEquals-equal values. Used internally for structural dedup/sort (e.g. DXNSortedSet's uniqueness invariant) and as a deterministic tiebreaker for kinds with no natural element order (map/set).

        Parameters

        • value: unknown

        Returns string

    • dxnCompare: function
      • Total order over DXN values. Cross-kind comparisons fall back to KIND_RANK (this library's own implementation-defined choice, see module doc); same-kind comparisons use each kind's natural order.

        Parameters

        • a: unknown
        • b: unknown

        Returns -1 | 0 | 1

    • dxnEquals: function
      • Structural equality between two DXN values, recursing into every collection/wrapper shape. Two NaN floats are equal (DXN treats NaN as one specific scalar value, not "incomparable" the way IEEE 754 === does).

        Parameters

        • a: unknown
        • b: unknown

        Returns boolean

    • kindOf: function
      • Identifies the DXN "kind" of a value for cross-type ranking and same-kind dispatch. Native JS shapes are recognized directly; DXN* wrapper instances are recognized via their shared dxnType prototype tag.

        Parameters

        • value: unknown

        Returns string