Interface Params

Hierarchy

Params

Index

Properties

from? fullsearch? id limit? options? order? query sort?

Properties

`Optional` from

from?: null | number

Start returning records from here

`Optional` fullsearch

fullsearch?: null | boolean

The query

id

id: null | number

Glossary entry ID

`Optional` limit

limit?: null | number

Number of records to return

`Optional` options

options?: api.mod.glossary.get_entries_by_search.ParamsOptions

An array of options

`Optional` order

order?: null | string

Order by: 'CONCEPT', 'CREATION' or 'UPDATE'

query

query: null | string

The query string

`Optional` sort

sort?: null | string

The direction of the order: 'ASC' or 'DESC'

Generated using TypeDoc