Reference · Look words up by reading, written form, English meaning, kanji or romaji
FindOptionstype
How findByMeaning and wordsWithKanji are asked: the mode and the lists, as for a lookup, and how many words to give.
Import it
import type { FindOptions } from "@johnmorrisdotca/jisho/words";
Definition
type FindOptions = WordsOptions & {
readonly limit?: number;
};
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. |
limit (optional) | number | undefined | The most words to give, and so the most pieces of the dictionary to fetch: 10 unless given, and no more than 20. |
Examples
import type { FindOptions } from "@johnmorrisdotca/jisho/words";
const options: FindOptions = { limit: 5, mode: "safe" };
console.log(options.limit);5What it prints (run when this page was built)