Skip to main content
Version: 0.17

Interface: JSONAPISourceSettings<QO, TO, QB, TB>

Type parameters​

NameType
QOextends JSONAPIQueryOptions = JSONAPIQueryOptions
TOextends JSONAPITransformOptions = JSONAPITransformOptions
QBRecordQueryBuilder
TBRecordTransformBuilder

Hierarchy​

  • RecordSourceSettings<QO, TO, QB, TB>

    ↳ JSONAPISourceSettings

Properties​

RequestProcessorClass​

• Optional RequestProcessorClass: (settings: JSONAPIRequestProcessorSettings) => JSONAPIRequestProcessor

Type declaration​

• new JSONAPISourceSettings(settings)

Parameters​
NameType
settingsJSONAPIRequestProcessorSettings

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:110


SerializerClass​

• Optional SerializerClass: (settings: JSONAPISerializerSettings) => JSONAPISerializer

Type declaration​

• new JSONAPISourceSettings(settings)

Parameters​
NameType
settingsJSONAPISerializerSettings

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:107


URLBuilderClass​

• Optional URLBuilderClass: (settings: JSONAPIURLBuilderSettings) => JSONAPIURLBuilder

Type declaration​

• new JSONAPISourceSettings(settings)

Parameters​
NameType
settingsJSONAPIURLBuilderSettings

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:113


allowedContentTypes​

• Optional allowedContentTypes: string[]

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:103


autoActivate​

• Optional autoActivate: boolean

Inherited from​

RecordSourceSettings.autoActivate

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:12


autoUpgrade​

• Optional autoUpgrade: boolean

Automatically upgrade this source whenever its schema is upgraded.

Override the upgrade method to provide an upgrade implementation.

default true

Inherited from​

RecordSourceSettings.autoUpgrade

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:43


autoValidate​

• Optional autoValidate: boolean

Automatically validate the contents of all requests.

If true, builds a validatorFor function if one has not been provided. This will include standard validators as well as any custom validators that may be provided.

default true

Inherited from​

RecordSourceSettings.autoValidate

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:35


bucket​

• Optional bucket: Bucket<unknown>

Inherited from​

RecordSourceSettings.bucket

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:9


defaultFetchSettings​

• Optional defaultFetchSettings: FetchSettings

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:102


defaultQueryOptions​

• Optional defaultQueryOptions: DefaultRequestOptions<QO>

Inherited from​

RecordSourceSettings.defaultQueryOptions

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:15


defaultTransformOptions​

• Optional defaultTransformOptions: DefaultRequestOptions<TO>

Inherited from​

RecordSourceSettings.defaultTransformOptions

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:16


host​

• Optional host: string

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:101


keyMap​

• Optional keyMap: RecordKeyMap

Inherited from​

RecordSourceSettings.keyMap

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:15


maxRequestsPerQuery​

• Optional maxRequestsPerQuery: number

Deprecated in favor of defaultQueryOptions.maxRequests

deprecated since v0.17, remove in v0.18

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:97


maxRequestsPerTransform​

• Optional maxRequestsPerTransform: number

Deprecated in favor of defaultTransformOptions.maxRequests

deprecated since v0.17, remove in v0.18

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:90


name​

• Optional name: string

Overrides​

RecordSourceSettings.name

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:99


namespace​

• Optional namespace: string

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:100


normalizer​

• Optional normalizer: RecordNormalizer<string, RecordIdentity, UninitializedRecord>

Inherited from​

RecordSourceSettings.normalizer

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:16


queryBuilder​

• Optional queryBuilder: QB

Inherited from​

RecordSourceSettings.queryBuilder

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:10


requestQueueSettings​

• Optional requestQueueSettings: TaskQueueSettings<string, unknown, unknown>

Inherited from​

RecordSourceSettings.requestQueueSettings

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:13


schema​

• schema: RecordSchema

Inherited from​

RecordSourceSettings.schema

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:14


serializerClassFor​

• Optional serializerClassFor: SerializerClassForFn<Serializer<unknown, unknown, unknown, unknown>>

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:105


serializerFor​

• Optional serializerFor: SerializerForFn<Serializer<unknown, unknown, unknown, unknown>>

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:104


serializerSettingsFor​

• Optional serializerSettingsFor: SerializerSettingsForFn

Defined in​

packages/@orbit/jsonapi/src/jsonapi-source.ts:106


syncQueueSettings​

• Optional syncQueueSettings: TaskQueueSettings<string, unknown, unknown>

Inherited from​

RecordSourceSettings.syncQueueSettings

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:14


transformBuilder​

• Optional transformBuilder: TB

Inherited from​

RecordSourceSettings.transformBuilder

Defined in​

packages/@orbit/data/dist/modules/source.d.ts:11


validatorFor​

• Optional validatorFor: ValidatorForFn<StandardValidator | StandardRecordValidator>

A completely custom set of validators.

Inherited from​

RecordSourceSettings.validatorFor

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:20


validators​

• Optional validators: Dict<StandardValidator | StandardRecordValidator>

Custom validators to override, and be merged with, the standard ones which will be built as long as autoValidate !== false.

Inherited from​

RecordSourceSettings.validators

Defined in​

packages/@orbit/records/dist/modules/record-source.d.ts:25