MatchOptionstype

A set of regions made from a list of place names somebody pasted.

A teacher with eight prefecture names in a lesson plan should not have to find each one on the map. Matching is deliberately forgiving in the ways a paste is messy and strict everywhere else: case and surrounding space never matter, a name may be the English, the Japanese, the short Japanese or the reading, and a line that matches nothing is reported rather than dropped. It is never fuzzy: "Tokyo" must not quietly become Tochigi.

import type { MatchOptions } from "@johnmorrisdotca/chizu";

type MatchOptions = {
    optionalEnding?: RegExp;
};

import { loadDivisions } from "@johnmorrisdotca/chizu/load";
import { placesFromText, type MatchOptions } from "@johnmorrisdotca/chizu";

const japan = (await loadDivisions("jp"))!;
const options: MatchOptions = { optionalEnding: /[県府都道]$/u };
console.log(placesFromText("東京\n大阪\n北海道", japan.regions, options).codes);
// [ '13', '27', '1' ]

[ '13', '27', '1' ]