GetObjectParams | @gdwc/drupal-state

Describes get object parameters.

Index

all: boolean

If true, DrupalState fetches all pages of an object if there is more than one.

anon: boolean

If true and valid credentials are passed in when creating the instance of DrupalState, the request will be made anonymously

id: string

The id of the object in Drupal

objectName: string

The name of the object in Drupal

params: string | DrupalJsonApiParams

A string of Drupal JSON:API parameters.

example: 'include=field_media_image, Or an instance of DrupalJsonApi Params.
see: https://www.npmjs.com/package/drupal-jsonapi-params

query: string | boolean

refresh: boolean

If true, data will be fetched from Drupal regardless of its existence in state

res: boolean | ServerResponse<IncomingMessage>

If included, the server response is passed to allow DrupalState to set headers among other things.

see: https://nodejs.org/docs/latest-v16.x/api/http.html#class-httpserverresponse