`LoadWordsOptions`type

How loadWords is asked.

Import it

import type { LoadWordsOptions } from "@johnmorrisdotca/jisho/words";

Definition

type LoadWordsOptions = WordsOptions & {
    readonly previous?: Words;
    readonly romaji?: boolean;
    readonly inflected?: boolean;
};

Name	Type	Description
`mode` (optional)	`WordsMode \| undefined`	`"safe"` unless you say `"unfiltered"`. Safe fetches only files that hold none of what it leaves out, and so fetches less; unfiltered fetches one file more for each piece, and gives everything.
`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.
`previous` (optional)	`Words \| undefined`	Words loaded before, in the same mode: what they hold is kept, and pieces they came from are not fetched again.
`romaji` (optional)	`boolean \| undefined`	Read a text of Latin letters as romaji and load the kana it could be (`kami` is かみ). Ask `wordsOf` the same way. Off unless given: `AI` and `CD` are written forms too.
`inflected` (optional)	`boolean \| undefined`	Also load the dictionary forms a text could be conjugated from (食べなかった loads 食べる), for `inflectedOf`. Off unless given: it fetches a few pieces more.

import type { LoadWordsOptions } from "@johnmorrisdotca/jisho/words";

const options: LoadWordsOptions = { mode: "safe" };
console.log(options.mode);

safe

What it prints (run when this page was built)

View source Edit on GitHubMade from the source of @johnmorrisdotca/jisho 2.11.0.