Skip to main content

foundation-comms.datasourceoptions

Home > @genesislcap/foundation-comms > DatasourceOptions

DatasourceOptions interface

Options that can be passed when initializing a datasource.

Signature:

export interface DatasourceOptions 

Properties

Property

Modifiers

Type

Description

criteria?

string

(Optional) The criteria used to filter data in the datasource.

disablePolling?

boolean

(Optional) Whether to disable polling when using request/reply

fields?

string

(Optional) The fields to include in the returned data.

isSnapshot?

boolean

(Optional) Whether the datasource is a snapshot or not.

maxRows?

number

(Optional) The maximum number of rows to return from the datasource.

maxView?

number

(Optional) The maximum number of rows to track as part of a client "view"

movingView?

boolean

(Optional) Defines the behaviour of the client view when new rows are received in real time.

offset?

number

(Optional) The offset to use when fetching data.

orderBy?

string

(Optional) The field to use for sorting the data.

pollingInterval?

number

(Optional) The polling interval to use when using request/reply.

pollTriggerEvents?

string[]

(Optional) Array of event names that will trigger an additional poll.

request?

any

(Optional) The request to send to the server.

requestAutoSetup?

boolean

(Optional) Whether the Datasource service will setup RQUEST object based on metadata.

resourceName?

string

(Optional) The name of the resource to use for the datasource.

reverse?

boolean

(Optional) Whether to return the data in reverse order or not.

viewNumber?

number

(Optional) The current page/"view" number being displayed.