Lawtext core references / core/src/data/query / Query

Class: Query<TItem>

Defined in: core/src/data/query.ts:65 (opens in a new tab)

The query object that represents a source list and a filtering criteria.

フィルタ条件と検索元リストを表すクエリオブジェクト。

Example

A Query works as an async generator.

Query は async generator として使用できます。

const query = new Query(population, criteria);
for await (const item of query) {
    console.log(item);
}

Extended by

LawQuery

Type Parameters

• TItem

Implements

AsyncIterable<TItem>

Constructors

new Query()

new Query<TItem>(population, criteria, options?): Query<TItem>

Defined in: core/src/data/query.ts:79 (opens in a new tab)

Instanciate a Query.

Parameters

population

AsyncIterable<TItem>

a source list

criteria

a filtering criteria

null | QueryCriteria<TItem>

options?

Partial<QueryOptions>

options

Returns

Query<TItem>

Properties

criteria

criteria: null | CoreQueryCriteria<TItem>

Defined in: core/src/data/query.ts:70 (opens in a new tab)

options

options: QueryOptions

Defined in: core/src/data/query.ts:71 (opens in a new tab)

population

population: AsyncIterable<TItem>

Defined in: core/src/data/query.ts:69 (opens in a new tab)

Methods

[asyncIterator]()

[asyncIterator](): AsyncGenerator<TItem, void, undefined>

Defined in: core/src/data/query.ts:105 (opens in a new tab)

Returns

AsyncGenerator<TItem, void, undefined>

Implementation of

AsyncIterable.[asyncIterator]

assign()

assign<T>(func, criteria, options?): Query<T extends undefined | void ? never : T & TItem>

Defined in: core/src/data/query.ts:180 (opens in a new tab)

Apply a function for each filtered item and iterate the merged object with the returned and original object.

フィルタ後の要素ごとに関数を実行し、返り値と元の要素のプロパティをマージしたオブジェクトを列挙します。

Type Parameters

• T

Parameters

func

(item) => T | Promise<T>

a function to be called for each filtered item
要素ごとに実行される関数

criteria

an additional criteria applied after merge / マージ後に適用するフィルタ条件

null | QueryCriteria<T extends undefined | void ? never : T & TItem>

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

Query<T extends undefined | void ? never : T & TItem>

a new Query that yields merged objects
マージされたオブジェクトを列挙する新しい Query

filter()

filter(criteria, options?): this

Defined in: core/src/data/query.ts:211 (opens in a new tab)

Apply an additional filter.

フィルタを追加します。

Parameters

criteria

an additional criteria / 追加するフィルタ条件

null | QueryCriteria<TItem>

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

this

a new Query that applies criteria to the filtered items of the original Query
フィルタ後の項目を検索元とし、criteria を検索条件とする新しい Query

forEach()

forEach(func): Promise<void>

Defined in: core/src/data/query.ts:376 (opens in a new tab)

Invoke func for each filtered item. Running this function will invoke the whole iteration process of the Query.

列挙された要素ごとに func を実行します。この関数を実行すると Query の列挙を最後まで実行します。

Parameters

func

(item) => unknown

a function to be called for each item
要素ごとに実行される関数

Returns

Promise<void>

limit()

limit(max, options?): this

Defined in: core/src/data/query.ts:296 (opens in a new tab)

Yield until it reaches the maximum count.

出力の最大件数を設定します。

Parameters

max

number

the maximum count
最大件数

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

this

a new Query that yields until it reaches the maximum count.
最大件数に達するまで列挙を続ける新しい Query

map()

map<T, TRet>(func, criteria, options?): Query<Awaited<TRet>>

Defined in: core/src/data/query.ts:127 (opens in a new tab)

Apply a function for each filtered item.

フィルタ後の要素ごとに関数を実行します。

Type Parameters

• T

• TRet = T extends undefined | void ? never : T

Parameters

func

(item) => T | Promise<T>

a function to be called for each filtered item
要素ごとに実行される関数

criteria

an additional criteria applied after filtering / 関数実行後に適用するフィルタ条件

null | QueryCriteria<TRet>

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

Query<Awaited<TRet>>

a new Query that yields items returned by func
func の返り値を列挙する新しい Query

mapWorkers()

mapWorkers<T, TRet>(workersPool, criteria, options?): Query<Awaited<TRet>>

Defined in: core/src/data/query.ts:149 (opens in a new tab)

Type Parameters

• T

• TRet = T extends undefined | void ? never : T

Parameters

workersPool

WorkersPool<TItem, TRet>

criteria

null | QueryCriteria<TRet>

options?

Partial<QueryOptions>

Returns

Query<Awaited<TRet>>

new()

protected new(population, criteria, overrideOptions?): this

Defined in: core/src/data/query.ts:97 (opens in a new tab)

Parameters

population

AsyncIterable<TItem>

criteria

null | QueryCriteria<TItem>

overrideOptions?

Partial<QueryOptions>

Returns

this

pick()

pick<K>(...keys): Query<Awaited<Pick<TItem, K>>>

Defined in: core/src/data/query.ts:337 (opens in a new tab)

Pick properties of each item.

特定のプロパティ以外のプロパティを削除したオブジェクトを列挙します。

Type Parameters

• K extends string | number | symbol

Parameters

keys

...K[]

the keys of properties to be picked
抜き出すプロパティのキー

Returns

Query<Awaited<Pick<TItem, K>>>

a new Query that yields the objects with the picked properties
プロパティを抜き出した新しいオブジェクトの内容を列挙する新しい Query

property()

property<K>(key): Query<Awaited<TItem[K]>>

Defined in: core/src/data/query.ts:325 (opens in a new tab)

Yield a property of each item.

特定のプロパティの内容を一つ抜き出して列挙します。

Type Parameters

• K extends string | number | symbol

Parameters

key

K

the key of a property to be picked
抜き出すプロパティのキー

Returns

Query<Awaited<TItem[K]>>

a new Query that yields the picked property
抜き出したプロパティの内容を列挙する新しい Query

skip()

skip(count, options?): this

Defined in: core/src/data/query.ts:265 (opens in a new tab)

Skip specified count.

指定した件数スキップします。

Parameters

count

number

count to skip
スキップする件数

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

this

a new Query that yields after skipping specified count.
指定した件数のスキップ後列挙を続ける新しい Query

toArray()

toArray(options): Promise<TItem[]>

Defined in: core/src/data/query.ts:358 (opens in a new tab)

Generate an array from the Query. Running this function will invoke the whole iteration process of the Query.

Query から配列を生成します。この関数を実行すると Query の列挙を最後まで実行します。

Parameters

options

options.preserveCache <boolean>: whether to suggest the Query to preserve the cached data for each item, which normally will be cleared after yield (default: false)
Queryにキャッシュされたデータを削除せずそのまま残すかどうかを指示します。

preserveCache

boolean

Returns

Promise<TItem[]>

a Promise that resolves a generated array
生成された配列を返す Promise

while()

while(func, yieldLast, options?): this

Defined in: core/src/data/query.ts:232 (opens in a new tab)

Yield while func returns true.

func が true を返す間、列挙を続けます。

Parameters

func

(item) => boolean | Promise<boolean>

a function to be called for each filtered item. Returning false terminates the iteration.
要素ごとに実行される関数。falseを返すと列挙を停止します。

yieldLast

boolean = false

whether to return the item that caused func returned false
funcがfalseを返す要因となった要素を出力するかどうか

options?

Partial<QueryOptions>

options which override the original ones / 上書きするオプション項目

Returns

this

a new Query that yields while func returns true
func が true を返す間列挙を続ける新しい Query

Lawqueryitem Lawcriteriaargs