`FindOptions`型

リファレンスの説明と例は英語です。見出しと目次は日本語です。

How findByMeaning and wordsWithKanji are asked: the mode and the lists, as for a lookup, and how many words to give.

インポート

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

定義

type FindOptions = WordsOptions & {
    readonly limit?: number;
};

メンバー

名前	型	説明
`mode` (省略可)	`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` (省略可)	`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` (省略可)	`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` (省略可)	`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.

例

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

const options: FindOptions = { limit: 5, mode: "safe" };
console.log(options.limit);

出力（このページを作ったときに実行した結果）

ソースを見る GitHub で編集@johnmorrisdotca/jisho 2.11.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。

FindOptions型

定義

メンバー

例

`FindOptions`型