Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GetObjectByPathParams

Describes get object by Path alias.

Hierarchy

  • SharedParams
    • GetObjectByPathParams

Index

Properties

Optional anon

anon: boolean

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

objectName

objectName: string

The name of the object in Drupal

example

'node--article'

Optional params

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

path

path: string

The path to the object that Decoupled Router resolves to

see

https://www.drupal.org/project/decoupled_router

example

'/recipes/fiery-chili-sauce'

Optional query

query: string | boolean
deprecated

since 4.0.0

Optional refresh

refresh: boolean

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

Optional res

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

Generated using TypeDoc