@johnmorrisdotca/kuni 1.3.0 → 1.5.0

package/dist/facts.d.cts

@@ -1,5 +1,5 @@
-import { C as CountryFacts, L as LatLon } from './types-KWZz5xby.cjs';
-export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-KWZz5xby.cjs';
+import { C as CountryFacts, L as LatLon } from './types-C7CG02m1.cjs';
+export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-C7CG02m1.cjs';
 
 /**
  * The day the Wikidata snapshot was read: every figure in /facts is as Wikidata gave it on this day.
@@ -22,12 +22,12 @@ declare const FACTS_READ = "2026-10-09";
  * ```ts
  * import { facts } from "@johnmorrisdotca/kuni/facts";
  *
- * facts("JP")?.population;    // 123802000
- * facts("JP")?.populationYear; // 2024
- * facts("FR")?.borders;        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
- * facts("GB")?.drivingSide;    // "left"
- * facts("US")?.weekStart;      // "sun"
- * facts("XX");                 // null
+ * console.log(facts("JP")?.population);    // 123802000
+ * console.log(facts("JP")?.populationYear); // 2024
+ * console.log(facts("FR")?.borders);        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
+ * console.log(facts("GB")?.drivingSide);    // "left"
+ * console.log(facts("US")?.weekStart);      // "sun"
+ * console.log(facts("XX"));                 // null
  * ```
  */
 declare const facts: (code: string) => CountryFacts | null;
@@ -57,7 +57,7 @@ declare const allFacts: () => readonly CountryFacts[];
  * ```ts
  * import { distanceKm, facts } from "@johnmorrisdotca/kuni/facts";
  *
- * Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!)); // 9558
+ * console.log(Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!))); // 9558
  * ```
  */
 declare const distanceKm: (from: LatLon, to: LatLon) => number;

package/dist/facts.d.ts

@@ -1,5 +1,5 @@
-import { C as CountryFacts, L as LatLon } from './types-KWZz5xby.js';
-export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-KWZz5xby.js';
+import { C as CountryFacts, L as LatLon } from './types-C7CG02m1.js';
+export { D as DrivingSide, H as HourCycle, M as MeasurementSystem, P as PaperSize, W as WeekStart } from './types-C7CG02m1.js';
 
 /**
  * The day the Wikidata snapshot was read: every figure in /facts is as Wikidata gave it on this day.
@@ -22,12 +22,12 @@ declare const FACTS_READ = "2026-10-09";
  * ```ts
  * import { facts } from "@johnmorrisdotca/kuni/facts";
  *
- * facts("JP")?.population;    // 123802000
- * facts("JP")?.populationYear; // 2024
- * facts("FR")?.borders;        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
- * facts("GB")?.drivingSide;    // "left"
- * facts("US")?.weekStart;      // "sun"
- * facts("XX");                 // null
+ * console.log(facts("JP")?.population);    // 123802000
+ * console.log(facts("JP")?.populationYear); // 2024
+ * console.log(facts("FR")?.borders);        // ["AD", "BE", "BR", "CH", "DE", "ES", "IT", "LU", "MC", "SR"]
+ * console.log(facts("GB")?.drivingSide);    // "left"
+ * console.log(facts("US")?.weekStart);      // "sun"
+ * console.log(facts("XX"));                 // null
  * ```
  */
 declare const facts: (code: string) => CountryFacts | null;
@@ -57,7 +57,7 @@ declare const allFacts: () => readonly CountryFacts[];
  * ```ts
  * import { distanceKm, facts } from "@johnmorrisdotca/kuni/facts";
  *
- * Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!)); // 9558
+ * console.log(Math.round(distanceKm(facts("JP")!.capitalPoint!, facts("GB")!.capitalPoint!))); // 9558
  * ```
  */
 declare const distanceKm: (from: LatLon, to: LatLon) => number;

package/dist/groupings.d.cts

@@ -1,7 +1,16 @@
-import { G as GroupingKind, a as GroupingStatus } from './types-KWZz5xby.cjs';
-export { b as GROUPING_KINDS } from './types-KWZz5xby.cjs';
+import { G as GroupingKind, a as GroupingStatus } from './types-C7CG02m1.cjs';
+export { b as GROUPING_KINDS } from './types-C7CG02m1.cjs';
 
-/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`. */
+/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingMember } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingMember = {code:"DE",since:"1958-01-01",until:null};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingMember {
     /** The member's alpha-2 code: "DE". */
     code: string;
@@ -10,7 +19,16 @@ interface GroupingMember {
     /** The day it left, "2020-01-31"; `null` while it is a member. */
     until: string | null;
 }
-/** Another name a grouping goes by, in English and Japanese. */
+/** Another name a grouping goes by, in English and Japanese.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingName } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingName = {en:"Kansai region",ja:"関西地方",reading:"かんさいちほう"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingName {
     /** In English: "Kansai region". */
     en: string;
@@ -19,14 +37,33 @@ interface GroupingName {
     /** The Japanese in hiragana, where it has kanji: "かんさいちほう". */
     reading?: string;
 }
-/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended. */
+/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingOther } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingOther = {code:"UA",status:"candidate"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingOther {
     /** The country's alpha-2 code. */
     code: string;
     /** How it stands. */
     status: GroupingStatus;
 }
-/** Where a grouping's definition comes from, and the terms its list is under. */
+/** Where a grouping's definition comes from, and the terms its list is under.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingSource } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingSource = grouping("eu")!.source;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingSource {
     /** The source's name: "European Union, Countries". */
     name: string;
@@ -35,7 +72,17 @@ interface GroupingSource {
     /** The terms of the list as it is shipped here. */
     licence: string;
 }
-/** A grouping of countries, or of the subdivisions inside one country. */
+/** A grouping of countries, or of the subdivisions inside one country.
+ *
+ * @example
+ * ```ts
+ * import type { Grouping } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: Grouping = grouping("eu")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Grouping {
     /** A stable id in kebab case: "eu", "m49-030", "continent-as", "jp-kanto". */
     id: string;
@@ -78,14 +125,33 @@ interface Grouping {
     /** The day the list was true, "2026-10-09". */
     asOf: string;
 }
-/** What `groupings()` may be narrowed to. */
+/** What `groupings()` may be narrowed to.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingsOptions } from "@johnmorrisdotca/kuni/groupings";
+ * import { country } from "@johnmorrisdotca/kuni";
+ *
+ * const value: GroupingsOptions = {country:"JP"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingsOptions {
     /** Only groupings of this kind. */
     kind?: GroupingKind;
     /** Only groupings of the subdivisions inside this country (alpha-2, either case). */
     country?: string;
 }
-/** What `groupingsOf()` and `membersOf()` may be asked. */
+/** What `groupingsOf()` and `membersOf()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingDateOptions } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingDateOptions = {on:"2015-06-30"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingDateOptions {
     /**
      * A day, "2015-06-30": an international body's members on that day rather than now. A member whose start Wikidata
@@ -105,8 +171,8 @@ interface GroupingDateOptions {
  * ```ts
  * import { groupings } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupings({ kind: "continent" }).map((one) => one.name.en); // ["Africa", "Antarctica", "Asia", "Europe", ...]
- * groupings({ country: "JP" }).length;                         // 10: the eight 地方, and the nine-region variant's two
+ * console.log(groupings({ kind: "continent" }).map((one) => one.name.en)); // ["Africa", "Antarctica", "Asia", "Europe", ...]
+ * console.log(groupings({ country: "JP" }).length);                         // 10: the eight 地方, and the nine-region variant's two
  * ```
  */
 declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
@@ -119,10 +185,10 @@ declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
  * ```ts
  * import { grouping } from "@johnmorrisdotca/kuni/groupings";
  *
- * grouping("eu")?.members.length;    // 27
- * grouping("eu")?.name.ja;           // "欧州連合"
- * grouping("jp-kanto")?.members[5];  // "JP-13"
- * grouping("atlantis");              // null
+ * console.log(grouping("eu")?.members.length);    // 27
+ * console.log(grouping("eu")?.name.ja);           // "欧州連合"
+ * console.log(grouping("jp-kanto")?.members[5]);  // "JP-13"
+ * console.log(grouping("atlantis"));              // null
  * ```
  */
 declare const grouping: (id: string) => Grouping | null;
@@ -136,9 +202,9 @@ declare const grouping: (id: string) => Grouping | null;
  * ```ts
  * import { groupingsOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupingsOf("GB", { kind: "membership" }).map((one) => one.id);                    // ["un", "nato", "g7", ...]
- * groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu"); // true
- * groupingsOf("JP-13").map((one) => one.id);                                          // ["jp-kanto"]
+ * console.log(groupingsOf("GB", { kind: "membership" }).map((one) => one.id));                    // ["un", "nato", "g7", ...]
+ * console.log(groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu")); // true
+ * console.log(groupingsOf("JP-13").map((one) => one.id));                                          // ["jp-kanto"]
  * ```
  */
 declare const groupingsOf: (code: string, options?: GroupingDateOptions) => readonly Grouping[];
@@ -152,9 +218,9 @@ declare const groupingsOf: (code: string, options?: GroupingDateOptions) => read
  * ```ts
  * import { membersOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * membersOf("eu")?.includes("GB");                       // false
- * membersOf("eu", { on: "2019-06-30" })?.includes("GB"); // true
- * membersOf("us-pacific");                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
+ * console.log(membersOf("eu")?.includes("GB"));                       // false
+ * console.log(membersOf("eu", { on: "2019-06-30" })?.includes("GB")); // true
+ * console.log(membersOf("us-pacific"));                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
  * ```
  */
 declare const membersOf: (id: string, options?: GroupingDateOptions) => readonly string[] | null;

package/dist/groupings.d.ts

@@ -1,7 +1,16 @@
-import { G as GroupingKind, a as GroupingStatus } from './types-KWZz5xby.js';
-export { b as GROUPING_KINDS } from './types-KWZz5xby.js';
+import { G as GroupingKind, a as GroupingStatus } from './types-C7CG02m1.js';
+export { b as GROUPING_KINDS } from './types-C7CG02m1.js';
 
-/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`. */
+/** One period of membership of a body: a member from `since` (or a day Wikidata does not give) until `until`.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingMember } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingMember = {code:"DE",since:"1958-01-01",until:null};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingMember {
     /** The member's alpha-2 code: "DE". */
     code: string;
@@ -10,7 +19,16 @@ interface GroupingMember {
     /** The day it left, "2020-01-31"; `null` while it is a member. */
     until: string | null;
 }
-/** Another name a grouping goes by, in English and Japanese. */
+/** Another name a grouping goes by, in English and Japanese.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingName } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingName = {en:"Kansai region",ja:"関西地方",reading:"かんさいちほう"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingName {
     /** In English: "Kansai region". */
     en: string;
@@ -19,14 +37,33 @@ interface GroupingName {
     /** The Japanese in hiragana, where it has kanji: "かんさいちほう". */
     reading?: string;
 }
-/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended. */
+/** A country that stands with a body without being a member: a candidate, an associate, an observer or suspended.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingOther } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingOther = {code:"UA",status:"candidate"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingOther {
     /** The country's alpha-2 code. */
     code: string;
     /** How it stands. */
     status: GroupingStatus;
 }
-/** Where a grouping's definition comes from, and the terms its list is under. */
+/** Where a grouping's definition comes from, and the terms its list is under.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingSource } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingSource = grouping("eu")!.source;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingSource {
     /** The source's name: "European Union, Countries". */
     name: string;
@@ -35,7 +72,17 @@ interface GroupingSource {
     /** The terms of the list as it is shipped here. */
     licence: string;
 }
-/** A grouping of countries, or of the subdivisions inside one country. */
+/** A grouping of countries, or of the subdivisions inside one country.
+ *
+ * @example
+ * ```ts
+ * import type { Grouping } from "@johnmorrisdotca/kuni/groupings";
+ * import { grouping } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: Grouping = grouping("eu")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Grouping {
     /** A stable id in kebab case: "eu", "m49-030", "continent-as", "jp-kanto". */
     id: string;
@@ -78,14 +125,33 @@ interface Grouping {
     /** The day the list was true, "2026-10-09". */
     asOf: string;
 }
-/** What `groupings()` may be narrowed to. */
+/** What `groupings()` may be narrowed to.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingsOptions } from "@johnmorrisdotca/kuni/groupings";
+ * import { country } from "@johnmorrisdotca/kuni";
+ *
+ * const value: GroupingsOptions = {country:"JP"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingsOptions {
     /** Only groupings of this kind. */
     kind?: GroupingKind;
     /** Only groupings of the subdivisions inside this country (alpha-2, either case). */
     country?: string;
 }
-/** What `groupingsOf()` and `membersOf()` may be asked. */
+/** What `groupingsOf()` and `membersOf()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { GroupingDateOptions } from "@johnmorrisdotca/kuni/groupings";
+ *
+ * const value: GroupingDateOptions = {on:"2015-06-30"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface GroupingDateOptions {
     /**
      * A day, "2015-06-30": an international body's members on that day rather than now. A member whose start Wikidata
@@ -105,8 +171,8 @@ interface GroupingDateOptions {
  * ```ts
  * import { groupings } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupings({ kind: "continent" }).map((one) => one.name.en); // ["Africa", "Antarctica", "Asia", "Europe", ...]
- * groupings({ country: "JP" }).length;                         // 10: the eight 地方, and the nine-region variant's two
+ * console.log(groupings({ kind: "continent" }).map((one) => one.name.en)); // ["Africa", "Antarctica", "Asia", "Europe", ...]
+ * console.log(groupings({ country: "JP" }).length);                         // 10: the eight 地方, and the nine-region variant's two
  * ```
  */
 declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
@@ -119,10 +185,10 @@ declare const groupings: (options?: GroupingsOptions) => readonly Grouping[];
  * ```ts
  * import { grouping } from "@johnmorrisdotca/kuni/groupings";
  *
- * grouping("eu")?.members.length;    // 27
- * grouping("eu")?.name.ja;           // "欧州連合"
- * grouping("jp-kanto")?.members[5];  // "JP-13"
- * grouping("atlantis");              // null
+ * console.log(grouping("eu")?.members.length);    // 27
+ * console.log(grouping("eu")?.name.ja);           // "欧州連合"
+ * console.log(grouping("jp-kanto")?.members[5]);  // "JP-13"
+ * console.log(grouping("atlantis"));              // null
  * ```
  */
 declare const grouping: (id: string) => Grouping | null;
@@ -136,9 +202,9 @@ declare const grouping: (id: string) => Grouping | null;
  * ```ts
  * import { groupingsOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * groupingsOf("GB", { kind: "membership" }).map((one) => one.id);                    // ["un", "nato", "g7", ...]
- * groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu"); // true
- * groupingsOf("JP-13").map((one) => one.id);                                          // ["jp-kanto"]
+ * console.log(groupingsOf("GB", { kind: "membership" }).map((one) => one.id));                    // ["un", "nato", "g7", ...]
+ * console.log(groupingsOf("GB", { kind: "membership", on: "2015-01-01" }).some((one) => one.id === "eu")); // true
+ * console.log(groupingsOf("JP-13").map((one) => one.id));                                          // ["jp-kanto"]
  * ```
  */
 declare const groupingsOf: (code: string, options?: GroupingDateOptions) => readonly Grouping[];
@@ -152,9 +218,9 @@ declare const groupingsOf: (code: string, options?: GroupingDateOptions) => read
  * ```ts
  * import { membersOf } from "@johnmorrisdotca/kuni/groupings";
  *
- * membersOf("eu")?.includes("GB");                       // false
- * membersOf("eu", { on: "2019-06-30" })?.includes("GB"); // true
- * membersOf("us-pacific");                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
+ * console.log(membersOf("eu")?.includes("GB"));                       // false
+ * console.log(membersOf("eu", { on: "2019-06-30" })?.includes("GB")); // true
+ * console.log(membersOf("us-pacific"));                               // ["US-AK", "US-CA", "US-HI", "US-OR", "US-WA"]
  * ```
  */
 declare const membersOf: (id: string, options?: GroupingDateOptions) => readonly string[] | null;

package/dist/index.cjs

@@ -634,7 +634,7 @@ var CONTINENTS = ["AF", "AN", "AS", "EU", "NA", "OC", "SA"];
 var LANGUAGES = ["en", "ja"];
 
 // src/version.ts
-var VERSION = "1.3.0";
+var VERSION = "1.5.0";
 
 // src/index.ts
 var LEADING_THE = /^the /;

package/dist/index.d.cts

@@ -1,6 +1,6 @@
 export { COUNTRY_CODES, CountryCode, isCountryCode } from './codes.cjs';
-import { c as Continent, d as Language, e as Country } from './types-KWZz5xby.cjs';
-export { f as CONTINENTS, g as LANGUAGES, S as Subdivision, h as SubdivisionType } from './types-KWZz5xby.cjs';
+import { g as Continent, d as Language, h as Country } from './types-C7CG02m1.cjs';
+export { i as CONTINENTS, j as LANGUAGES, S as Subdivision, f as SubdivisionType } from './types-C7CG02m1.cjs';
 
 /**
  * What two ways of typing a name have in common: width (full-width letters to ASCII, half-width katakana to full),
@@ -13,9 +13,9 @@ export { f as CONTINENTS, g as LANGUAGES, S as Subdivision, h as SubdivisionType
  * ```ts
  * import { fold } from "@johnmorrisdotca/kuni";
  *
- * fold("Côte d'Ivoire");   // "cote divoire"
- * fold("ＵＳＡ");           // "usa"
- * fold("ドイツ");           // "どいつ"
+ * console.log(fold("Côte d'Ivoire"));   // "cote divoire"
+ * console.log(fold("ＵＳＡ"));           // "usa"
+ * console.log(fold("ドイツ"));           // "どいつ"
  * ```
  */
 declare const fold: (text: string) => string;
@@ -30,16 +30,43 @@ declare const fold: (text: string) => string;
  * console.log(`kuni ${VERSION}`);
  * ```
  */
-declare const VERSION = "1.3.0";
+declare const VERSION = "1.5.0";
 
-/** The order `countries()` lists them in: "code" (alpha-2), "en" (by English name) or "ja" (by Japanese name, in kana). */
+/** The order `countries()` lists them in: "code" (alpha-2), "en" (by English name) or "ja" (by Japanese name, in kana).
+ *
+ * @example
+ * ```ts
+ * import type { CountryOrder } from "@johnmorrisdotca/kuni";
+ *
+ * const value: CountryOrder = "code";
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 type CountryOrder = "code" | "en" | "ja";
-/** What `countries()` may be asked. */
+/** What `countries()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { CountriesOptions } from "@johnmorrisdotca/kuni";
+ *
+ * const value: CountriesOptions = {order:"ja"};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface CountriesOptions {
     /** "code" (the default) is alpha-2 order; "en" and "ja" are by name, as `countries` says. */
     order?: CountryOrder;
 }
-/** What `countryName()` may be asked. */
+/** What `countryName()` may be asked.
+ *
+ * @example
+ * ```ts
+ * import type { CountryNameOptions } from "@johnmorrisdotca/kuni";
+ *
+ * const value: CountryNameOptions = {short:true};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface CountryNameOptions {
     /** The short form where CLDR has one ("UK", アメリカ), the full name otherwise. */
     short?: boolean;
@@ -53,11 +80,11 @@ interface CountryNameOptions {
  * ```ts
  * import { country } from "@johnmorrisdotca/kuni";
  *
- * country("JP")?.name.en;     // "Japan"
- * country("jpn")?.alpha2;     // "JP"
- * country("392")?.name.ja;    // "日本"
- * country("JP")?.capital;     // { "en": "Tokyo", "ja": "東京" }
- * country("XX");              // null
+ * console.log(country("JP")?.name.en);     // "Japan"
+ * console.log(country("jpn")?.alpha2);     // "JP"
+ * console.log(country("392")?.name.ja);    // "日本"
+ * console.log(country("JP")?.capital);     // { "en": "Tokyo", "ja": "東京" }
+ * console.log(country("XX"));              // null
  * ```
  */
 declare const country: (code: string) => Country | null;
@@ -72,9 +99,9 @@ declare const country: (code: string) => Country | null;
  * ```ts
  * import { countries } from "@johnmorrisdotca/kuni";
  *
- * countries().length;                          // 250
- * countries({ order: "en" })[0].name.en;       // "Afghanistan"
- * countries({ order: "ja" })[0].name.ja;       // "アイスランド"
+ * console.log(countries().length);                          // 250
+ * console.log(countries({ order: "en" })[0].name.en);       // "Afghanistan"
+ * console.log(countries({ order: "ja" })[0].name.ja);       // "アイスランド"
  * ```
  */
 declare const countries: (options?: CountriesOptions) => readonly Country[];
@@ -89,11 +116,11 @@ declare const countries: (options?: CountriesOptions) => readonly Country[];
  * ```ts
  * import { countryByName } from "@johnmorrisdotca/kuni";
  *
- * countryByName("ドイツ")?.alpha2;          // "DE"
- * countryByName("Holland")?.name.ja;        // "オランダ"
- * countryByName("ＵＳＡ")?.alpha2;           // "US"
- * countryByName("cote d'ivoire")?.alpha2;   // "CI"
- * countryByName("Narnia");                  // null
+ * console.log(countryByName("ドイツ")?.alpha2);          // "DE"
+ * console.log(countryByName("Holland")?.name.ja);        // "オランダ"
+ * console.log(countryByName("ＵＳＡ")?.alpha2);           // "US"
+ * console.log(countryByName("cote d'ivoire")?.alpha2);   // "CI"
+ * console.log(countryByName("Narnia"));                  // null
  * ```
  */
 declare const countryByName: (text: string) => Country | null;
@@ -108,10 +135,10 @@ declare const countryByName: (text: string) => Country | null;
  * ```ts
  * import { countryName } from "@johnmorrisdotca/kuni";
  *
- * countryName("US");                         // "United States"
- * countryName("US", "ja", { short: true });  // "アメリカ"
- * countryName("GB", "en", { short: true });  // "UK"
- * countryName("XX");                         // null
+ * console.log(countryName("US"));                         // "United States"
+ * console.log(countryName("US", "ja", { short: true }));  // "アメリカ"
+ * console.log(countryName("GB", "en", { short: true }));  // "UK"
+ * console.log(countryName("XX"));                         // null
  * ```
  */
 declare const countryName: (code: string, language?: Language, options?: CountryNameOptions) => string | null;
@@ -125,8 +152,8 @@ declare const countryName: (code: string, language?: Language, options?: Country
  * ```ts
  * import { flag } from "@johnmorrisdotca/kuni";
  *
- * flag("JP");   // "🇯🇵"
- * flag("XX");   // null
+ * console.log(flag("JP"));   // "🇯🇵"
+ * console.log(flag("XX"));   // null
  * ```
  */
 declare const flag: (code: string) => string | null;
@@ -140,8 +167,8 @@ declare const flag: (code: string) => string | null;
  * ```ts
  * import { continentName } from "@johnmorrisdotca/kuni";
  *
- * continentName("AS");         // "Asia"
- * continentName("AS", "ja");   // "アジア"
+ * console.log(continentName("AS"));         // "Asia"
+ * console.log(continentName("AS", "ja"));   // "アジア"
  * ```
  */
 declare const continentName: (continent: Continent, language?: Language) => string | null;
@@ -155,8 +182,8 @@ declare const continentName: (continent: Continent, language?: Language) => stri
  * ```ts
  * import { subregionName } from "@johnmorrisdotca/kuni";
  *
- * subregionName("030");         // "Eastern Asia"
- * subregionName("030", "ja");   // "東アジア"
+ * console.log(subregionName("030"));         // "Eastern Asia"
+ * console.log(subregionName("030", "ja"));   // "東アジア"
  * ```
  */
 declare const subregionName: (subregion: string, language?: Language) => string | null;