Interface SearchSpecificationBase<TFields, TSelectedFields>

Base specification shared by all search-based pagination strategies.

interface SearchSpecificationBase<
    TFields extends Record<string, any>,
    TSelectedFields extends keyof TFields = keyof TFields,
> {
    fields: readonly EntityLoaderSearchFieldSpecification<
        TFields,
        TSelectedFields,
    >[];
    term: string;
}

Type Parameters

TFields extends Record<string, any>
TSelectedFields extends keyof TFields = keyof TFields

Hierarchy (View Summary)

SearchSpecificationBase
- ILikeSearchSpecification
- TrigramSearchSpecification

Index

Properties

Properties

fields

fields: readonly EntityLoaderSearchFieldSpecification<TFields, TSelectedFields>[]

The fields to search within.

term

term: string

The search term to search for. Must be a non-empty string.