Skip to main content

Interface: UserAutocompleteParams

types/user.UserAutocompleteParams

BaseSearchParams interface

Hierarchy​

Properties​

description​

• Optional description: string

Filter using field description.

Defined in​

types/user.ts:26

gender​

• Optional gender: string

Filter using field gender type.

Defined in​

types/user.ts:14

limit​

• Optional limit: number

Number of results to return per page.

Inherited from​

BaseSearchParams.limit

Defined in​

types/baseParams.ts:9

location​

• Optional location: string

Filter using field location.

Defined in​

types/user.ts:22

offset​

• Optional offset: number

The initial index from which to return the results.

Inherited from​

BaseSearchParams.offset

Defined in​

types/baseParams.ts:13

ordering​

• Optional ordering: string

Ordering fields (eg?: ?ordering=username). Minus char is used for descending ordering, eg. -username

Defined in​

types/user.ts:30

real_name​

• Optional real_name: string

Filter using field real_name.

Defined in​

types/user.ts:18

• Optional search: string

A search term.

Inherited from​

BaseSearchParams.search

Defined in​

types/baseParams.ts:24

username​

• Optional username: string

Filter using field username.

Defined in​

types/user.ts:10