Interface SearchOptions

interface SearchOptions {
    defaultFields?: string[];
    fieldsAliases?: Record<string, string[]>;
    limit?: number;
    logger?: Logger;
    orderBy?: string;
    tableName?: string;
}

Properties

defaultFields? fieldsAliases? limit? logger? orderBy? tableName?

Properties

OptionaldefaultFields

defaultFields?: string[]

In which fields to search. If not provided all fields will be searched.

OptionalfieldsAliases

fieldsAliases?: Record<string, string[]>

Aliases for the fields. If not provided the fields will be used as aliases It is possible to specify many fields in which the search will be performed

Optionallimit

limit?: number

The maximum number of results to return

Default

1000

Optionallogger

logger?: Logger

We can log more information about how queries are executed

OptionalorderBy

orderBy?: string

Specify the order of the results

Default

''

OptionaltableName

tableName?: string

The name of the table to search. If not provided and there is only a table in the database it will be sued.

Settings

Member Visibility

On This Page

Properties