Module query

Index

Interfaces

Type aliases

TransformedQueryParams

Functions

Type aliases

TransformedQueryParams

TransformedQueryParams: Record<string, unknown>

Functions

createQueryUrl

createQueryUrl(endpoint: string, params: TransformedQueryParams, pageIndex?: number): string

- Defined in src/query.ts:172
Parameters
- endpoint: string
- params: TransformedQueryParams
- Optional pageIndex: number
Returns string

transformEventQueryParams

transformEventQueryParams(oid?: number, params?: EventQueryParams): TransformedQueryParams

- Defined in src/query.ts:233
Transforms an object of parameters into valid event query params.

internal

Parameters
- Optional oid: number
- Optional params: EventQueryParams
Returns TransformedQueryParams

transformMenuQueryParams

transformMenuQueryParams(params?: MenuQueryParams): TransformedQueryParams

- Defined in src/query.ts:293
Transforms an object of parameters into valid menu query params.

internal

Parameters
- Optional params: MenuQueryParams
Returns TransformedQueryParams

transformNotificationQueryParams

transformNotificationQueryParams(params?: NotificationQueryParams): TransformedQueryParams

- Defined in src/query.ts:312
Transforms an object of parameters into valid notification query params.

internal

Parameters
- Optional params: NotificationQueryParams
Returns TransformedQueryParams

transformPaginationParams

transformPaginationParams<T>(params?: T): TransformedQueryParams

- Defined in src/query.ts:207
Transforms an object containing pagination paramaters into valid menu pagination params.

internal

Type parameters
- T: PaginationQueryParams
Parameters
- Optional params: T
Returns TransformedQueryParams

Generated using TypeDoc