Reference · Look words up by reading, written form, English meaning, kanji or romaji
WordsOptionstype
How words are looked up: the mode, and the consumer's own lists. Jisho keeps no list of words of its own.
Import it
import type { WordsOptions } from "@johnmorrisdotca/jisho/words";
Definition
type WordsOptions = {
readonly mode?: WordsMode;
readonly block?: readonly string[];
readonly allow?: readonly string[];
};
Members
| Name | Type | Description |
|---|---|---|
mode (optional) | WordsMode | undefined |
|
block (optional) | readonly string[] | undefined | Readings and written forms to leave out, on top of the mode. A reading that several words share names all of them. Applied only when given. |
allow (optional) | readonly string[] | undefined | Readings and written forms to keep and nothing else, on top of the mode and the block list. Applied only when given; an empty list keeps none. |
Examples
import type { WordsOptions } from "@johnmorrisdotca/jisho/words";
const options: WordsOptions = { mode: "safe", block: ["神"] };
console.log(options.mode);safeWhat it prints (run when this page was built)