@zsnout/ithkuil/generate/helpers/deep-freeze.d.ts

A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.

import type { AffixEntry } from "../../data/affixes.js";
import type { RootEntry } from "../../data/roots.js";
import type { VowelForm } from "../../parse/vowel-form.js";
import type { Core } from "../../script/secondary/core.js";
import type { Extension } from "../../script/secondary/extension.js";
import type { MoodOrCaseScope } from "../formative/slot-8/mood-or-case-scope.js";
import { type WithWYAlternative } from "./with-wy-alternative.js";
/** Types which remain the same after being deeply frozen. */
export type PreservedWhenDeeplyFrozen = Function | WithWYAlternative | VowelForm | MoodOrCaseScope | AffixEntry | RootEntry | Core | Extension;
/**
 * Deeply freezes an object.
 *
 * @template T The object to be deeply frozen.
 */
export type DeepFreeze<T> = T extends PreservedWhenDeeplyFrozen ? T : T extends object ? {
    readonly [K in keyof T]: DeepFreeze<T[K]>;
} : T;
/**
 * Deeply freezes a value. This prevents properties from being added, removed,
 * or changed, and deeply freezes all values of the object. For arrays, elements
 * will be deeply frozen.
 *
 * No other values (such as `Set`s and `Map`s) are treated specially, as this
 * project does not use them.
 *
 * @param value The value to be deeply frozen.
 * @returns A reference to the original value, now deeply frozen.
 */
export declare function deepFreeze<const T>(value: T): DeepFreeze<T>;
/** Types which remain the same after being deeply frozen and null-prototyped. */
export type PreservedWhenDeeplyFrozenAndNullPrototyped = Core | Extension;
/**
 * Deeply freezes and null-prototypes an object.
 *
 * @template T The object to be deeply frozen.
 */
export type DeepFreezeAndNullPrototype<T> = T extends WithWYAlternative ? {
    readonly defaultValue: string;
    readonly valueAfterW: string;
    readonly valueAfterY: string;
} : T extends VowelForm<infer U> ? {
    readonly sequence: U;
    readonly degree: 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
    readonly hasGlottalStop: boolean;
} : T extends MoodOrCaseScope<infer M, infer C, infer N, infer A> ? {
    readonly mood: M;
    readonly caseScope: C;
    readonly nonAspectualValue: N;
    readonly aspectualValue: A;
} : T extends PreservedWhenDeeplyFrozenAndNullPrototyped ? T : T extends ReadonlyArray<any> ? {
    readonly [K in keyof T as K extends number | "length" ? K : never]: T[K];
} : T extends object ? {
    readonly [K in keyof T]: DeepFreeze<T[K]>;
} : T;
/**
 * Deeply freezes a value. This prevents properties from being added, removed,
 * or changed, and deeply freezes all values of the object. For arrays, elements
 * will be deeply frozen.
 *
 * In addition, all objects in the tree will have their prototypes removed.
 *
 * No other values (such as `Set`s and `Map`s) are treated specially, as this
 * project does not use them.
 *
 * @param value The value to be deeply frozen.
 * @returns A reference to the original value, now deeply frozen.
 */
export declare function deepFreezeAndNullPrototype<const T>(value: T): DeepFreezeAndNullPrototype<T>;