Interface SearchParameters

Query parameters for searching.

Hierarchy

  • SearchParameters

Properties

AUTHORS?: boolean

Whether the author section should be included into the search. The author section contains the names of the contributors in the Catalogue.

Default Value

false

FILES?: boolean

Default Value

false

PKG?: boolean

Whether the package section should be included into the search. The package section contains the text fields of a package entry in the Catalogue.

Default Value

false

PORTAL?: boolean

Whether the portal section should be included into the search. The portal section contains the text of the portal pages.

Default Value

false

TOPICS?: boolean

Whether the topics section should be included into the search. The topics section contains the text fields of the topics in the Catalogue.

Default Value

false

ext?: boolean

Whether the sections are requested explicitly. If the value is false then all default sections are searched. Otherwise the sections to be searched have to be specified with additional parameters.

Default Value

false

See

max?: number

The number of hits maximally returned. Larger values will be reduced to 256. Lower values will be replaced by the default value.

Default Value

16

offset?: number

The offset for paging. The accompanying parameter max contains the page size. This parameter contains the first hit to be returned. If a negative number is passed in then it is replaced by 0. If the offset is larger than the number of actual hits then the list of hits will be empty.

See

SearchParameters#max

phrase: string

The words or search expressions to query for.

wildcard?: boolean

Default Value

false

Generated using TypeDoc