Class: RecordSource<QO, TO, QB, TB>

Abstract base class for record-based sources.

Type parameters

Name	Type
QO	extends RequestOptions = RecordSourceQueryOptions
TO	extends RequestOptions = RequestOptions
QB	RecordQueryBuilder
TB	RecordTransformBuilder

Hierarchy

• Source<QO, TO, QB, TB>

  ↳ RecordSource

Constructors

constructor

• new RecordSource<QO, TO, QB, TB>(settings)

Type parameters

Name	Type
QO	extends RequestOptions = RecordSourceQueryOptions
TO	extends RequestOptions = RequestOptions
QB	RecordQueryBuilder<string, RecordIdentity>
TB	RecordTransformBuilder<string, RecordIdentity, UninitializedRecord>

Parameters

Name	Type
settings	RecordSourceSettings<QO, TO, QB, TB>

Overrides

Source<QO, TO, QB, TB\>.constructor

Defined in

packages/@orbit/records/src/record-source.ts:93

Accessors

activated

• get activated(): Promise<void>

Returns

Promise<void>

Inherited from

Source.activated

Defined in

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

---

bucket

• get bucket(): undefined | Bucket<unknown>

Returns

undefined | Bucket<unknown>

Inherited from

Source.bucket

Defined in

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

---

defaultQueryOptions

• get defaultQueryOptions(): undefined | DefaultRequestOptions<QueryOptions>

Returns

undefined | DefaultRequestOptions<QueryOptions>

Inherited from

Source.defaultQueryOptions

Defined in

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

• set defaultQueryOptions(options): void

Parameters

Name	Type
options	undefined | DefaultRequestOptions<QueryOptions>

Returns

void

Inherited from

Source.defaultQueryOptions

Defined in

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

---

defaultTransformOptions

• get defaultTransformOptions(): undefined | DefaultRequestOptions<TransformOptions>

Returns

undefined | DefaultRequestOptions<TransformOptions>

Inherited from

Source.defaultTransformOptions

Defined in

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

• set defaultTransformOptions(options): void

Parameters

Name	Type
options	undefined | DefaultRequestOptions<TransformOptions>

Returns

void

Inherited from

Source.defaultTransformOptions

Defined in

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

---

keyMap

• get keyMap(): undefined | RecordKeyMap

Returns

undefined | RecordKeyMap

Defined in

packages/@orbit/records/src/record-source.ts:171

---

name

• get name(): undefined | string

Returns

undefined | string

Inherited from

Source.name

Defined in

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

---

queryBuilder

• get queryBuilder(): QB

Returns

QB

Overrides

Source.queryBuilder

Defined in

packages/@orbit/records/src/record-source.ts:181

---

requestQueue

• get requestQueue(): TaskQueue<string, unknown, unknown, unknown>

Returns

TaskQueue<string, unknown, unknown, unknown>

Inherited from

Source.requestQueue

Defined in

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

---

schema

• get schema(): RecordSchema

Returns

RecordSchema

Defined in

packages/@orbit/records/src/record-source.ts:167

---

syncQueue

• get syncQueue(): TaskQueue<string, unknown, unknown, unknown>

Returns

TaskQueue<string, unknown, unknown, unknown>

Inherited from

Source.syncQueue

Defined in

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

---

transformBuilder

• get transformBuilder(): TB

Returns

TB

Overrides

Source.transformBuilder

Defined in

packages/@orbit/records/src/record-source.ts:185

---

transformLog

• get transformLog(): Log

Returns

Log

Inherited from

Source.transformLog

Defined in

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

---

validatorFor

• get validatorFor(): undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Returns

undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Defined in

packages/@orbit/records/src/record-source.ts:175

Methods

activate

▸ activate(): Promise<void>

Returns

Promise<void>

Inherited from

Source.activate

Defined in

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

---

deactivate

▸ deactivate(): Promise<void>

Returns

Promise<void>

Inherited from

Source.deactivate

Defined in

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

---

emit

▸ emit(event, ...args): void

Parameters

Name	Type
event	Event
...args	unknown[]

Returns

void

Inherited from

Source.emit

Defined in

packages/@orbit/core/dist/modules/evented.d.ts:23

---

getQueryOptions

▸ getQueryOptions(query, expression?): undefined | QO

Parameters

Name	Type
query	Query<QueryExpression>
expression?	QueryExpression

Returns

undefined | QO

Inherited from

Source.getQueryOptions

Defined in

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

---

getTransformOptions

▸ getTransformOptions(transform, operation?): undefined | TO

Parameters

Name	Type
transform	Transform<Operation>
operation?	Operation

Returns

undefined | TO

Inherited from

Source.getTransformOptions

Defined in

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

---

listeners

▸ listeners(event): Listener[]

Parameters

Name	Type
event	Event

Returns

Listener[]

Inherited from

Source.listeners

Defined in

packages/@orbit/core/dist/modules/evented.d.ts:24

---

off

▸ off(event, listener?): void

Parameters

Name	Type
event	Event
listener?	Listener

Returns

void

Inherited from

Source.off

Defined in

packages/@orbit/core/dist/modules/evented.d.ts:21

---

on

▸ on(event, listener): () => void

Parameters

Name	Type
event	Event
listener	Listener

Returns

fn

▸ (): void

Returns

void

Inherited from

Source.on

Defined in

packages/@orbit/core/dist/modules/evented.d.ts:20

---

one

▸ one(event, listener): () => void

Parameters

Name	Type
event	Event
listener	Listener

Returns

fn

▸ (): void

Returns

void

Inherited from

Source.one

Defined in

packages/@orbit/core/dist/modules/evented.d.ts:22

---

perform

▸ perform(task): Promise<unknown>

Parameters

Name	Type
task	Task<string, unknown, unknown>

Returns

Promise<unknown>

Inherited from

Source.perform

Defined in

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

---

transformed

▸ transformed(transforms): Promise<void>

Notifies listeners that this source has been transformed by emitting the transform event.

Resolves when any promises returned to event listeners are resolved.

Also, adds an entry to the Source's transformLog for each transform.

Parameters

Name	Type
transforms	Transform<Operation>[]

Returns

Promise<void>

Inherited from

Source.transformed

Defined in

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

---

upgrade

▸ upgrade(): Promise<void>

Upgrade source as part of a schema upgrade.

Returns

Promise<void>

Overrides

Source.upgrade

Defined in

packages/@orbit/records/src/record-source.ts:192