Lawtext core references • Docs

Lawtext core references / core/src/data/query / LawQuery

Class: LawQuery<TItem>

Lawtext query の法令検索を行う Query の派生クラス。ここに列挙されているもの以外のクラスメンバーについては Query を参照してください。

Extends

Query<TItem>

Type Parameters

• TItem extends LawQueryItem = LawQueryItem

Constructors

new LawQuery()

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

Parameters

• population: AsyncIterable<TItem>

• criteria: null | LawCriteria<TItem>

• options?: Partial<QueryOptions>

Properties

criteria

criteria: null | CoreQueryCriteria<TItem>

Inherited from

Query.criteria

Defined in

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

options

options: QueryOptions

Inherited from

Query.options

Defined in

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

population

population: AsyncIterable<TItem>

Inherited from

Query.population

Defined in

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

Methods

[asyncIterator]()

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

Returns

AsyncGenerator<TItem, void, undefined>

Inherited from

Query.[asyncIterator]

Defined in

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

assign()

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

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

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

Type Parameters

• T

Parameters

• func

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

• criteria: null | LawCriteria<T extends undefined | void ? never : T & TItem> = null

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

• options?: Partial<QueryOptions>

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

Returns

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

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

Overrides

Query.assign

Defined in

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

assignDocument()

assignDocument<TEnsure>(ensure, options?): LawQuery<TItem & object>

法令XMLのDOMを取得して追加したオブジェクトを列挙します。

Type Parameters

• TEnsure extends boolean = true

Parameters

• ensure: TEnsure = ...

法令XMLが取得できたもののみを列挙するかどうか（デフォルト: true）

• options?: Partial<QueryOptions>

上書きするオプション項目

Returns

LawQuery<TItem & object>

法令XMLのDOMを document プロパティとして追加したオブジェクトを列挙する新しい Query

Defined in

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

filter()

filter(criteria): this

Apply an additional filter.

フィルタを追加します。

Parameters

• criteria: null | LawCriteria<TItem>

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

Returns

this

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

Overrides

Query.filter

Defined in

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

forEach()

forEach(func): Promise<void>

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

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

Parameters

• func

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

Returns

Promise<void>

Inherited from

Query.forEach

Defined in

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

limit()

limit(max, options?): this

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

Inherited from

Query.limit

Defined in

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

map()

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

Apply a function for each filtered item.

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

Type Parameters

• T

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

Parameters

• func

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

• criteria: null | QueryCriteria<TRet> = null

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

• options?: Partial<QueryOptions>

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

Returns

Query<Awaited<TRet>>

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

Inherited from

Query.map

Defined in

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

mapWorkers()

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

Type Parameters

• T

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

Parameters

• workersPool: WorkersPool<TItem, TRet>

• criteria: null | QueryCriteria<TRet> = null

• options?: Partial<QueryOptions>

Returns

Query<Awaited<TRet>>

Inherited from

Query.mapWorkers

Defined in

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

new()

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

Parameters

• population: AsyncIterable<TItem>

• criteria: null | LawCriteria<TItem>

• overrideOptions?: Partial<QueryOptions>

Returns

this

Overrides

Query.new

Defined in

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

pick()

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

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

Inherited from

Query.pick

Defined in

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

property()

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

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

Inherited from

Query.property

Defined in

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

skip()

skip(count, options?): this

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

Inherited from

Query.skip

Defined in

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

toArray()

toArray(options): Promise<TItem[]>

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にキャッシュされたデータを削除せずそのまま残すかどうかを指示します。

• options.preserveCache: boolean