Interface Params

Hierarchy

Params

Index

Properties

field? from? id letter limit? options? sort?

Properties

`Optional` field

field?: null | string

Search and order using: 'FIRSTNAME' or 'LASTNAME'

`Optional` from

from?: null | number

Start returning records from here

id

id: null | number

Glossary entry ID

letter

letter: null | string

First letter of firstname or lastname, or either keywords: 'ALL' or 'SPECIAL'.

`Optional` limit

limit?: null | number

Number of records to return

`Optional` options

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

An array of options

`Optional` sort

sort?: null | string

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

Generated using TypeDoc