UNPKG

@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.

github.com/zsakowitz/ithkuil

zsakowitz/ithkuil

92 lines (91 loc) • 3.12 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
import { WithWYAlternative } from "../../helpers/with-wy-alternative.js"; /** An aspect. */ export type Aspect = "RTR" | "PRS" | "HAB" | "PRG" | "IMM" | "PCS" | "REG" | "SMM" | "ATP" | "RSM" | "CSS" | "PAU" | "RGR" | "PCL" | "CNT" | "ICS" | "EXP" | "IRP" | "PMP" | "CLM" | "DLT" | "TMP" | "XPD" | "LIM" | "EPD" | "PTC" | "PPR" | "DCL" | "CCL" | "CUL" | "IMD" | "TRD" | "TNS" | "ITC" | "MTV" | "SQN"; /** An array containing all aspects. */ export declare const ALL_ASPECTS: readonly Aspect[]; /** An object mapping aspects to their Ithkuilic translations. */ export declare const ASPECT_TO_ITHKUIL_MAP: { readonly RTR: "a"; readonly PRS: "ä"; readonly HAB: "e"; readonly PRG: "i"; readonly IMM: "ëi"; readonly PCS: "ö"; readonly REG: "o"; readonly SMM: "ü"; readonly ATP: "u"; readonly RSM: "ai"; readonly CSS: "au"; readonly PAU: "ei"; readonly RGR: "eu"; readonly PCL: "ëu"; readonly CNT: "ou"; readonly ICS: "oi"; readonly EXP: "iu"; readonly IRP: "ui"; readonly PMP: WithWYAlternative; readonly CLM: WithWYAlternative; readonly DLT: WithWYAlternative; readonly TMP: WithWYAlternative; readonly XPD: "eë"; readonly LIM: WithWYAlternative; readonly EPD: WithWYAlternative; readonly PTC: WithWYAlternative; readonly PPR: WithWYAlternative; readonly DCL: "ao"; readonly CCL: "aö"; readonly CUL: "eo"; readonly IMD: "eö"; readonly TRD: "oë"; readonly TNS: "öe"; readonly ITC: "oe"; readonly MTV: "öa"; readonly SQN: "oa"; }; /** An object mapping aspects to their names. */ export declare const ASPECT_TO_NAME_MAP: { readonly RTR: "Retrospective"; readonly PRS: "Prospective"; readonly HAB: "Habitual"; readonly PRG: "Progressive"; readonly IMM: "Imminent"; readonly PCS: "Precessive"; readonly REG: "Regulative"; readonly SMM: "Summative"; readonly ATP: "Anticipatory"; readonly RSM: "Resumptive"; readonly CSS: "Cessative"; readonly PAU: "Pausal"; readonly RGR: "Regressive"; readonly PCL: "Preclusive"; readonly CNT: "Continuative"; readonly ICS: "Incessative"; readonly EXP: "Experiential"; readonly IRP: "Interruptive"; readonly PMP: "Preemptive"; readonly CLM: "Climactic"; readonly DLT: "Dilatory"; readonly TMP: "Temporary"; readonly XPD: "Expenditive"; readonly LIM: "Limitative"; readonly EPD: "Expeditive"; readonly PTC: "Protractive"; readonly PPR: "Preparatory"; readonly DCL: "Disclusive"; readonly CCL: "Conclusive"; readonly CUL: "Culminative"; readonly IMD: "Intermediative"; readonly TRD: "Tardative"; readonly TNS: "Transitional"; readonly ITC: "Intercommutative"; readonly MTV: "Motive"; readonly SQN: "Sequential"; }; /** * Converts an aspect into Ithkuil. * * @param aspect The aspect to be converted. * @returns A string or `WithWYAlternative` containing romanized Ithkuilic text * representing the aspect. */ export declare function aspectToIthkuil(aspect: Aspect): string | WithWYAlternative;