@johnmorrisdotca/kuni 1.3.0 → 1.4.0

package/dist/{types-DYHGRkCK.d.cts → types-DcG1fN95.d.cts}

@@ -6,13 +6,33 @@
  * ```ts
  * import { SUBDIVISION_TYPES } from "@johnmorrisdotca/kuni/subdivisions";
  *
- * SUBDIVISION_TYPES.includes("prefecture"); // true
+ * console.log(SUBDIVISION_TYPES.includes("prefecture")); // true
  * ```
  */
 declare const SUBDIVISION_TYPES: readonly ["atoll", "autonomous-community", "autonomous-region", "borough", "canton", "capital-district", "circuit", "city", "council-area", "country", "county", "department", "district", "division", "emirate", "governorate", "island", "krai", "metropolis", "municipality", "oblast", "parish", "prefecture", "principal-area", "province", "quarter", "region", "republic", "special-administrative-region", "state", "territory", "unitary-authority", "urban-prefecture", "voivodeship", "zone"];
-/** A kind of subdivision, in kebab case: "prefecture", "state", "autonomous-community". */
+/** A kind of subdivision, in kebab case: "prefecture", "state", "autonomous-community".
+ *
+ * @example
+ * ```ts
+ * import type { SubdivisionType } from "@johnmorrisdotca/kuni/subdivisions";
+ * import { SUBDIVISION_TYPES } from "@johnmorrisdotca/kuni/subdivisions";
+ *
+ * const value: SubdivisionType = SUBDIVISION_TYPES[0];
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 type SubdivisionType = (typeof SUBDIVISION_TYPES)[number];
-/** A subdivision of a country (a state, a province, a prefecture), with its ISO 3166-2 code, as the lookups hand it out (frozen). */
+/** A subdivision of a country (a state, a province, a prefecture), with its ISO 3166-2 code, as the lookups hand it out (frozen).
+ *
+ * @example
+ * ```ts
+ * import type { Subdivision } from "@johnmorrisdotca/kuni/subdivisions";
+ * import { subdivision } from "@johnmorrisdotca/kuni/subdivisions";
+ *
+ * const value: Subdivision = subdivision("JP-13")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Subdivision {
     /** ISO 3166-2, always in full: "JP-13", "CA-ON", "US-NY" */
     code: string;
@@ -34,14 +54,33 @@ interface Subdivision {
     /** The name in hiragana, for Japan's prefectures: "とうきょうと" */
     reading?: string;
 }
-/** A point on the earth, in degrees: north and east are positive. */
+/** A point on the earth, in degrees: north and east are positive.
+ *
+ * @example
+ * ```ts
+ * import type { LatLon } from "@johnmorrisdotca/kuni/facts";
+ *
+ * const value: LatLon = {lat:35.68,lon:139.76};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface LatLon {
     /** Latitude in degrees, north positive: -90 to 90. */
     lat: number;
     /** Longitude in degrees, east positive: -180 to 180. */
     lon: number;
 }
-/** The facts about one subdivision, from the /subdivision-facts entry: `null` where Wikidata has none, or gives two. */
+/** The facts about one subdivision, from the /subdivision-facts entry: `null` where Wikidata has none, or gives two.
+ *
+ * @example
+ * ```ts
+ * import type { SubdivisionFacts } from "@johnmorrisdotca/kuni/subdivision-facts";
+ * import { loadSubdivisionFacts } from "@johnmorrisdotca/kuni/subdivision-facts";
+ *
+ * const value: SubdivisionFacts = (await loadSubdivisionFacts("JP"))![0];
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface SubdivisionFacts {
     /** ISO 3166-2, "JP-13" */
     code: string;

package/dist/{types-DYHGRkCK.d.ts → types-DcG1fN95.d.ts}

@@ -6,13 +6,33 @@
  * ```ts
  * import { SUBDIVISION_TYPES } from "@johnmorrisdotca/kuni/subdivisions";
  *
- * SUBDIVISION_TYPES.includes("prefecture"); // true
+ * console.log(SUBDIVISION_TYPES.includes("prefecture")); // true
  * ```
  */
 declare const SUBDIVISION_TYPES: readonly ["atoll", "autonomous-community", "autonomous-region", "borough", "canton", "capital-district", "circuit", "city", "council-area", "country", "county", "department", "district", "division", "emirate", "governorate", "island", "krai", "metropolis", "municipality", "oblast", "parish", "prefecture", "principal-area", "province", "quarter", "region", "republic", "special-administrative-region", "state", "territory", "unitary-authority", "urban-prefecture", "voivodeship", "zone"];
-/** A kind of subdivision, in kebab case: "prefecture", "state", "autonomous-community". */
+/** A kind of subdivision, in kebab case: "prefecture", "state", "autonomous-community".
+ *
+ * @example
+ * ```ts
+ * import type { SubdivisionType } from "@johnmorrisdotca/kuni/subdivisions";
+ * import { SUBDIVISION_TYPES } from "@johnmorrisdotca/kuni/subdivisions";
+ *
+ * const value: SubdivisionType = SUBDIVISION_TYPES[0];
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 type SubdivisionType = (typeof SUBDIVISION_TYPES)[number];
-/** A subdivision of a country (a state, a province, a prefecture), with its ISO 3166-2 code, as the lookups hand it out (frozen). */
+/** A subdivision of a country (a state, a province, a prefecture), with its ISO 3166-2 code, as the lookups hand it out (frozen).
+ *
+ * @example
+ * ```ts
+ * import type { Subdivision } from "@johnmorrisdotca/kuni/subdivisions";
+ * import { subdivision } from "@johnmorrisdotca/kuni/subdivisions";
+ *
+ * const value: Subdivision = subdivision("JP-13")!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface Subdivision {
     /** ISO 3166-2, always in full: "JP-13", "CA-ON", "US-NY" */
     code: string;
@@ -34,14 +54,33 @@ interface Subdivision {
     /** The name in hiragana, for Japan's prefectures: "とうきょうと" */
     reading?: string;
 }
-/** A point on the earth, in degrees: north and east are positive. */
+/** A point on the earth, in degrees: north and east are positive.
+ *
+ * @example
+ * ```ts
+ * import type { LatLon } from "@johnmorrisdotca/kuni/facts";
+ *
+ * const value: LatLon = {lat:35.68,lon:139.76};
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface LatLon {
     /** Latitude in degrees, north positive: -90 to 90. */
     lat: number;
     /** Longitude in degrees, east positive: -180 to 180. */
     lon: number;
 }
-/** The facts about one subdivision, from the /subdivision-facts entry: `null` where Wikidata has none, or gives two. */
+/** The facts about one subdivision, from the /subdivision-facts entry: `null` where Wikidata has none, or gives two.
+ *
+ * @example
+ * ```ts
+ * import type { SubdivisionFacts } from "@johnmorrisdotca/kuni/subdivision-facts";
+ * import { loadSubdivisionFacts } from "@johnmorrisdotca/kuni/subdivision-facts";
+ *
+ * const value: SubdivisionFacts = (await loadSubdivisionFacts("JP"))![0];
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface SubdivisionFacts {
     /** ISO 3166-2, "JP-13" */
     code: string;

package/dist/withdrawn.d.cts

@@ -5,12 +5,22 @@
  * ```ts
  * import { WITHDRAWN_READ } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * WITHDRAWN_READ; // "2026-10-10"
+ * console.log(WITHDRAWN_READ); // "2026-10-10"
  * ```
  */
 declare const WITHDRAWN_READ = "2026-10-10";
 
-/** A country that was withdrawn from ISO 3166-1, as ISO 3166-3 lists it (frozen). */
+/** A country that was withdrawn from ISO 3166-1, as ISO 3166-3 lists it (frozen).
+ *
+ * @example
+ * ```ts
+ * import type { WithdrawnCountry } from "@johnmorrisdotca/kuni/withdrawn";
+ * import { withdrawn } from "@johnmorrisdotca/kuni/withdrawn";
+ *
+ * const value: WithdrawnCountry = withdrawn("SU")[0]!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface WithdrawnCountry {
     /** The four-letter ISO 3166-3 code: "SUHH" for the Soviet Union. Its first two letters are the alpha-2 code. */
     code: string;
@@ -51,8 +61,8 @@ interface WithdrawnCountry {
  * ```ts
  * import { withdrawnCountries } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * withdrawnCountries().length;                              // 31
- * withdrawnCountries().map((one) => one.alpha2).includes("SU"); // true
+ * console.log(withdrawnCountries().length);                              // 31
+ * console.log(withdrawnCountries().map((one) => one.alpha2).includes("SU")); // true
  * ```
  */
 declare const withdrawnCountries: () => readonly WithdrawnCountry[];
@@ -69,11 +79,11 @@ declare const withdrawnCountries: () => readonly WithdrawnCountry[];
  * ```ts
  * import { withdrawn } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * withdrawn("su")[0].name.en;        // "Soviet Union"
- * withdrawn("SU")[0].until;          // "1992"
- * withdrawn("YUCS")[0].successors;   // ["CS"]: itself withdrawn, and resolved by withdrawn("CS")
- * withdrawn("CS").map((one) => one.code); // ["CSXX", "CSHH"]
- * withdrawn("JP");                   // []
+ * console.log(withdrawn("su")[0].name.en);        // "Soviet Union"
+ * console.log(withdrawn("SU")[0].until);          // "1992"
+ * console.log(withdrawn("YUCS")[0].successors);   // ["CS"]: itself withdrawn, and resolved by withdrawn("CS")
+ * console.log(withdrawn("CS").map((one) => one.code)); // ["CSXX", "CSHH"]
+ * console.log(withdrawn("JP"));                   // []
  * ```
  */
 declare const withdrawn: (code: string) => readonly WithdrawnCountry[];

package/dist/withdrawn.d.ts

@@ -5,12 +5,22 @@
  * ```ts
  * import { WITHDRAWN_READ } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * WITHDRAWN_READ; // "2026-10-10"
+ * console.log(WITHDRAWN_READ); // "2026-10-10"
  * ```
  */
 declare const WITHDRAWN_READ = "2026-10-10";
 
-/** A country that was withdrawn from ISO 3166-1, as ISO 3166-3 lists it (frozen). */
+/** A country that was withdrawn from ISO 3166-1, as ISO 3166-3 lists it (frozen).
+ *
+ * @example
+ * ```ts
+ * import type { WithdrawnCountry } from "@johnmorrisdotca/kuni/withdrawn";
+ * import { withdrawn } from "@johnmorrisdotca/kuni/withdrawn";
+ *
+ * const value: WithdrawnCountry = withdrawn("SU")[0]!;
+ * console.log(typeof value === "object" ? Object.keys(value).slice(0,6) : value);
+ * ```
+ */
 interface WithdrawnCountry {
     /** The four-letter ISO 3166-3 code: "SUHH" for the Soviet Union. Its first two letters are the alpha-2 code. */
     code: string;
@@ -51,8 +61,8 @@ interface WithdrawnCountry {
  * ```ts
  * import { withdrawnCountries } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * withdrawnCountries().length;                              // 31
- * withdrawnCountries().map((one) => one.alpha2).includes("SU"); // true
+ * console.log(withdrawnCountries().length);                              // 31
+ * console.log(withdrawnCountries().map((one) => one.alpha2).includes("SU")); // true
  * ```
  */
 declare const withdrawnCountries: () => readonly WithdrawnCountry[];
@@ -69,11 +79,11 @@ declare const withdrawnCountries: () => readonly WithdrawnCountry[];
  * ```ts
  * import { withdrawn } from "@johnmorrisdotca/kuni/withdrawn";
  *
- * withdrawn("su")[0].name.en;        // "Soviet Union"
- * withdrawn("SU")[0].until;          // "1992"
- * withdrawn("YUCS")[0].successors;   // ["CS"]: itself withdrawn, and resolved by withdrawn("CS")
- * withdrawn("CS").map((one) => one.code); // ["CSXX", "CSHH"]
- * withdrawn("JP");                   // []
+ * console.log(withdrawn("su")[0].name.en);        // "Soviet Union"
+ * console.log(withdrawn("SU")[0].until);          // "1992"
+ * console.log(withdrawn("YUCS")[0].successors);   // ["CS"]: itself withdrawn, and resolved by withdrawn("CS")
+ * console.log(withdrawn("CS").map((one) => one.code)); // ["CSXX", "CSHH"]
+ * console.log(withdrawn("JP"));                   // []
  * ```
  */
 declare const withdrawn: (code: string) => readonly WithdrawnCountry[];