Class: JSONAPIRequestProcessor

Constructors

constructor

• new JSONAPIRequestProcessor(settings)

Parameters

Name	Type
settings	JSONAPIRequestProcessorSettings

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:88

Properties

allowedContentTypes

• allowedContentTypes: string[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:81

---

defaultFetchSettings

• defaultFetchSettings: FetchSettings

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:82

---

keyMap

• Optional keyMap: RecordKeyMap

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:84

---

schema

• schema: RecordSchema

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:83

---

sourceName

• sourceName: string

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:79

---

urlBuilder

• urlBuilder: JSONAPIURLBuilder

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:80

Accessors

serializer

• get serializer(): JSONAPISerializer

deprecated since v0.17, use serializerFor instead

Returns

JSONAPISerializer

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:138

---

serializerFor

• get serializerFor(): SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Returns

SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:151

Methods

buildFetchSettings

▸ buildFetchSettings(request): FetchSettings

Parameters

Name	Type
request	RecordQueryRequest | RecordTransformRequest

Returns

FetchSettings

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:245

---

customRequestOptions

▸ customRequestOptions(queryOrTransform, queryExpressionOrOperation): undefined | JSONAPIRequestOptions

deprecated since v0.17, use mergeRequestOptions instead

Parameters

Name	Type
queryOrTransform	RecordTransform | RecordQuery
queryExpressionOrOperation	RecordOperation | RecordQueryExpression

Returns

undefined | JSONAPIRequestOptions

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:304

---

fetch

▸ fetch(url, customSettings?): Promise<JSONAPIResponse>

Parameters

Name	Type
url	string
customSettings?	FetchSettings

Returns

Promise<JSONAPIResponse>

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:155

---

initFetchSettings

▸ initFetchSettings(customSettings?): FetchSettings

Parameters

Name	Type
customSettings	FetchSettings

Returns

FetchSettings

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:204

---

mergeRequestOptions

▸ mergeRequestOptions(options): undefined | JSONAPIRequestOptions

Parameters

Name	Type
options	undefined | JSONAPIRequestOptions | (undefined | JSONAPIRequestOptions)[]

Returns

undefined | JSONAPIRequestOptions

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:289

---

operationsFromDeserializedDocument

▸ operationsFromDeserializedDocument(deserialized): RecordOperation[]

Parameters

Name	Type
deserialized	RecordDocument

Returns

RecordOperation[]

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:227

---

preprocessResponseDocument

▸ preprocessResponseDocument(document, request): void

Parameters

Name	Type
document	undefined | ResourceDocument
request	RecordQueryRequest | RecordTransformRequest

Returns

void

Defined in

packages/@orbit/jsonapi/src/jsonapi-request-processor.ts:318