@zsnout/ithkuil
Version:
A set of tools which can generate and parse romanized Ithkuil text and which can generate Ithkuil script from text and JSON data.
316 lines (315 loc) • 17 kB
TypeScript
import type { Formative, FramedVerbalFormative, NominalFormative, PartialFormative, UnframedVerbalFormative } from "./index.js";
/** The default nominal formative. */
export declare const DEFAULT_NOMINAL_FORMATIVE: NominalFormative;
/** The default unframed verbal formative. */
export declare const DEFAULT_UNFRAMED_VERBAL_FORMATIVE: UnframedVerbalFormative;
/** The default framed verbal formative. */
export declare const DEFAULT_FRAMED_VERBAL_FORMATIVE: FramedVerbalFormative;
/** An object mapping from formative types to their default objects. */
export declare const DEFAULT_FORMATIVES_BY_TYPE: {
readonly "UNF/C": {
readonly version: import("./index.js").Version;
readonly stem: import("./index.js").Stem;
readonly root: string | readonly [import("../index.js").Referent, ...import("../index.js").Referent[]] | import("../index.js").NumericAdjunct | {
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
};
readonly function: import("./index.js").Function;
readonly specification: import("./index.js").Specification;
readonly context: import("./index.js").Context;
readonly slotVAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly ca: {
readonly affiliation: import("../index.js").Affiliation;
readonly configuration: import("../index.js").Configuration;
readonly extension: import("../index.js").Extension;
readonly perspective: import("../index.js").Perspective;
readonly essence: import("../index.js").Essence;
};
readonly slotVIIAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly vn: import("./index.js").Valence | import("./index.js").Aspect | import("./index.js").Phase | import("./index.js").Level | import("./index.js").Effect;
readonly shortcut: import("./shortcut-type.js").ShortcutType;
readonly type: "UNF/C";
readonly concatenationType: import("./index.js").ConcatenationType;
readonly caseScope: import("./index.js").CaseScope;
readonly case: import("./index.js").Case;
};
readonly "UNF/K": {
readonly version: import("./index.js").Version;
readonly stem: import("./index.js").Stem;
readonly root: string | readonly [import("../index.js").Referent, ...import("../index.js").Referent[]] | import("../index.js").NumericAdjunct | {
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
};
readonly function: import("./index.js").Function;
readonly specification: import("./index.js").Specification;
readonly context: import("./index.js").Context;
readonly slotVAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly ca: {
readonly affiliation: import("../index.js").Affiliation;
readonly configuration: import("../index.js").Configuration;
readonly extension: import("../index.js").Extension;
readonly perspective: import("../index.js").Perspective;
readonly essence: import("../index.js").Essence;
};
readonly slotVIIAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly vn: import("./index.js").Valence | import("./index.js").Aspect | import("./index.js").Phase | import("./index.js").Level | import("./index.js").Effect;
readonly shortcut: import("./shortcut-type.js").ShortcutType;
readonly type: "UNF/K";
readonly mood: import("./index.js").Mood;
readonly illocutionValidation: import("./index.js").IllocutionOrValidation;
};
readonly FRM: {
readonly version: import("./index.js").Version;
readonly stem: import("./index.js").Stem;
readonly root: string | readonly [import("../index.js").Referent, ...import("../index.js").Referent[]] | import("../index.js").NumericAdjunct | {
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
};
readonly function: import("./index.js").Function;
readonly specification: import("./index.js").Specification;
readonly context: import("./index.js").Context;
readonly slotVAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly ca: {
readonly affiliation: import("../index.js").Affiliation;
readonly configuration: import("../index.js").Configuration;
readonly extension: import("../index.js").Extension;
readonly perspective: import("../index.js").Perspective;
readonly essence: import("../index.js").Essence;
};
readonly slotVIIAffixes: readonly ({
readonly type: import("../index.js").AffixType;
readonly degree: import("../index.js").AffixDegree;
readonly cs: string | number | bigint;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly ca: {
readonly affiliation?: import("../index.js").Affiliation | undefined;
readonly configuration?: import("../index.js").Configuration | undefined;
readonly extension?: import("../index.js").Extension | undefined;
readonly perspective?: import("../index.js").Perspective | undefined;
readonly essence?: import("../index.js").Essence | undefined;
};
readonly cs?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly case?: undefined | undefined;
} | {
readonly referents: readonly [import("../index.js").Referent, ...import("../index.js").Referent[]];
readonly perspective?: "M" | "G" | "N" | undefined | undefined;
readonly case: import("../index.js").ReferentialAffixCase;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly type: import("../index.js").AffixType;
readonly isInverse: boolean;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
} | {
readonly case: import("./index.js").Case;
readonly cs?: undefined | undefined;
readonly ca?: undefined | undefined;
readonly referents?: undefined | undefined;
readonly type?: undefined | undefined;
})[];
readonly vn: import("./index.js").Valence | import("./index.js").Aspect | import("./index.js").Phase | import("./index.js").Level | import("./index.js").Effect;
readonly shortcut: import("./shortcut-type.js").ShortcutType;
readonly type: "FRM";
readonly caseScope: import("./index.js").CaseScope;
readonly case: import("./index.js").Case;
};
};
/**
* Completes a formative, filling in slots that are not passed in.
*
* @param formative The partial formative to be completed.
* @returns A complete formative.
*/
export declare function fillInDefaultFormativeSlots(formative: PartialFormative): Formative;