Interface: RecordSourceSettings<QO, TO, QB, TB>
Type parameters​
| Name | Type |
|---|---|
QO | extends RequestOptions = RecordSourceQueryOptions |
TO | extends RequestOptions = RequestOptions |
QB | RecordQueryBuilder |
TB | RecordTransformBuilder |
Hierarchy​
SourceSettings<QO,TO,QB,TB>↳
RecordSourceSettings
Properties​
autoActivate​
• Optional autoActivate: boolean
Inherited from​
SourceSettings.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
Defined in​
packages/@orbit/records/src/record-source.ts:64
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
Defined in​
packages/@orbit/records/src/record-source.ts:55
bucket​
• Optional bucket: Bucket<unknown>
Inherited from​
SourceSettings.bucket
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:9
defaultQueryOptions​
• Optional defaultQueryOptions: DefaultRequestOptions<QO>
Inherited from​
SourceSettings.defaultQueryOptions
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:15
defaultTransformOptions​
• Optional defaultTransformOptions: DefaultRequestOptions<TO>
Inherited from​
SourceSettings.defaultTransformOptions
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:16
keyMap​
• Optional keyMap: RecordKeyMap
Defined in​
packages/@orbit/records/src/record-source.ts:32
name​
• Optional name: string
Inherited from​
SourceSettings.name
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:8
normalizer​
• Optional normalizer: RecordNormalizer<string, RecordIdentity, UninitializedRecord>
Defined in​
packages/@orbit/records/src/record-source.ts:33
queryBuilder​
• Optional queryBuilder: QB
Inherited from​
SourceSettings.queryBuilder
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:10
requestQueueSettings​
• Optional requestQueueSettings: TaskQueueSettings<string, unknown, unknown>
Inherited from​
SourceSettings.requestQueueSettings
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:13
schema​
• schema: RecordSchema
Defined in​
packages/@orbit/records/src/record-source.ts:31
syncQueueSettings​
• Optional syncQueueSettings: TaskQueueSettings<string, unknown, unknown>
Inherited from​
SourceSettings.syncQueueSettings
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:14
transformBuilder​
• Optional transformBuilder: TB
Inherited from​
SourceSettings.transformBuilder
Defined in​
packages/@orbit/data/dist/modules/source.d.ts:11
validatorFor​
• Optional validatorFor: ValidatorForFn<StandardValidator | StandardRecordValidator>
A completely custom set of validators.
Defined in​
packages/@orbit/records/src/record-source.ts:38
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.