@johnmorrisdotca/kuni 1.2.0 → 1.4.0

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-ChquRAZM.cjs';
-export { f as CONTINENTS, g as LANGUAGES, S as Subdivision, h as SubdivisionType } from './types-ChquRAZM.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.2.0";
+declare const VERSION = "1.4.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;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export { COUNTRY_CODES, CountryCode, isCountryCode } from './codes.js';
-import { c as Continent, d as Language, e as Country } from './types-ChquRAZM.js';
-export { f as CONTINENTS, g as LANGUAGES, S as Subdivision, h as SubdivisionType } from './types-ChquRAZM.js';
+import { g as Continent, d as Language, h as Country } from './types-C7CG02m1.js';
+export { i as CONTINENTS, j as LANGUAGES, S as Subdivision, f as SubdivisionType } from './types-C7CG02m1.js';
 
 /**
  * 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.2.0";
+declare const VERSION = "1.4.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;