diff --git a/.vscode/settings.json b/.vscode/settings.json index 16bb2a8..3096819 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -64,6 +64,7 @@ "rima", "rimum", "rimus", + "sapienter", "sapientis", "sapientius", "scribere", diff --git a/adjectives/index.ts b/adjectives/index.ts index dd4bae4..7257ca6 100644 --- a/adjectives/index.ts +++ b/adjectives/index.ts @@ -11,6 +11,13 @@ const Options = z.object({ overrides: Overrides }).default({}); +/** The type for a declined adjective. This can be passed to {@link scriptor} for better intellisense. + * + * @example + * ```ts + * const declined = scriptor("sapiens, sapientis"); + * ``` + */ type AdjectiveOptions = { overrides?: AdjectiveShape } | undefined; diff --git a/adverbs/index.ts b/adverbs/index.ts index f9c0de8..d5bf669 100644 --- a/adverbs/index.ts +++ b/adverbs/index.ts @@ -11,6 +11,13 @@ const Options = z.object({ overrides: Overrides }).default({}); +/** The type for the forms of an adverb. This can be passed to {@link scriptor} for better intellisense. + * + * @example + * ```ts + * const forms = scriptor("sapienter"); + * ``` + */ type AdverbOptions = { overrides?: AdverbShape } | undefined; diff --git a/nouns/index.ts b/nouns/index.ts index e127ddb..37e28ed 100644 --- a/nouns/index.ts +++ b/nouns/index.ts @@ -20,6 +20,13 @@ const Options = z.object({ overrides: Overrides }).default({}); +/** The type for a declined noun. This can be passed to {@link scriptor} for better intellisense. + * + * @example + * ```ts + * const declined = scriptor("scriptor, scriptoris, m"); + * ``` + */ type NounOptions = { iStem?: boolean, overrides?: NounShape diff --git a/verbs/index.ts b/verbs/index.ts index 1060c2a..afb4e6d 100644 --- a/verbs/index.ts +++ b/verbs/index.ts @@ -11,6 +11,13 @@ const Options = z.object({ overrides: Overrides }).default({}); +/** The type for a conjugated verb. This can be passed to {@link scriptor} for better intellisense. + * + * @example + * ```ts + * const conjugated = scriptor("scribo, scribere, scripsi, scriptus"); + * ``` + */ type VerbOptions = { overrides?: VerbShape } | undefined;