Skip to main content
Version: 0.17

Interface: JSONAPIRequestOptions

Hierarchy​

  • RequestOptions

    ↳ JSONAPIRequestOptions

Properties​

fields​

• Optional fields: Dict<string | string[]>

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:12

filter​

• Optional filter: FilterSpecifier[] | Dict<string | string[]>

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:8

fullResponse​

• Optional fullResponse: boolean

Inherited from​

RequestOptions.fullResponse

Defined in​

packages/@orbit/data/dist/modules/request.d.ts:3

include​

• Optional include: string | string[] | string[][]

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:11

page​

• Optional page: PageSpecifier

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:10

partialSet​

• Optional partialSet: boolean

Explicit control over whether the resultset in a successful response should be interpreted as a partial set of related records. Currently, this option only applies to requests for related records.

Example usage: A request is made to a custom relationship url and you want the records returned to be added to the relationship, rather than to replace all existing members of that relationship.

If this property is not set, then data will be implicitly treated as a partial set of related records if:

  • a filter option is present in the request
  • a page option is present in the request
  • a prev or next link is present in the response document's top-level links object.

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:31

raiseNotFoundExceptions​

• Optional raiseNotFoundExceptions: boolean

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:7

settings​

• Optional settings: FetchSettings

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:33

sort​

• Optional sort: string | (string | SortSpecifier)[]

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:9

sources​

• Optional sources: Object

Index signature​

â–ª [name: string]: RequestOptions

Inherited from​

RequestOptions.sources

Defined in​

packages/@orbit/data/dist/modules/request.d.ts:4

url​

• Optional url: string

Defined in​

packages/@orbit/jsonapi/src/lib/jsonapi-request-options.ts:34