Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • JsonApiResponse

Index

Properties

data

data: PlainObject<any> | PlainObject<any>[]

Either a plain object representing a single result or an array representing multiple results in a response

Optional headers

headers: PlainObject<any>

The list of http headers from the response

isSingleResult

isSingleResult: boolean

True if this is a single entity result

Optional links

links: PlainObject<any>

Can contain the link information given by the response

Optional meta

meta: { pagination?: PlainObject<any> }

Additional meta information about this response

Type declaration

  • [key: string]: any
  • Optional pagination?: PlainObject<any>

    Optional pagination for this response

Optional status

status: number

The http status code of the response

Generated using TypeDoc