Reference · Framing, geometry and quiz tools
findFeaturesfunction
The features a few typed letters may mean, best first: a name (English or Japanese) or reading that is the words
typed, then one that begins with them, then one with a word that does, then one that holds them anywhere; within
each, the higher ranked first. Case, accents, kana and spacing never matter, so caspian, カスピ and かすぴ all find
the Caspian Sea. Up to limit (default 10).
Import it
import { findFeatures } from "@johnmorrisdotca/chizu";Definition
function findFeatures<T extends Pick<ChizuFeature, "code" | "name" | "nameJa" | "reading" | "rank">>(features: readonly T[], typed: string, options?: { limit?: number; }): T[]Parameters
| Name | Type | Description |
|---|---|---|
features | readonly T[] | The native features available for name lookup. |
typed | string | The English/Japanese feature name, code or reading to match. |
options (optional) | { limit?: number; } | The optional native drawing, matching, layout or quiz settings described by this signature. |
Returns
T[]
The features a few typed letters may mean, best first: a name (English or Japanese) or reading that is the words typed, then one that begins with them, then one with a word that does, then one that holds them anywhere; within each, the higher ranked first. Case, accents, kana and spacing never matter, so caspian, カスピ and かすぴ all find the Caspian Sea. Up to limit (default 10).
Examples
import { loadFeatures } from "@johnmorrisdotca/chizu/load";
import { findFeatures } from "@johnmorrisdotca/chizu";
const world = (await loadFeatures("world"))!;
console.log(findFeatures(world.features, "caspian")[0]?.nameJa, findFeatures(world.features, "びわ").length);
console.log(findFeatures(world.features, "ナイル").map((one) => one.name));
// カスピ海 0
// [ 'Nile', 'White Nile', 'Blue Nile' ]カスピ海 0
[ 'Nile', 'White Nile', 'Blue Nile' ]What it prints (run when this page was built)