Skip to main content
Version: 0.17

Class: RecordCache<QueryOptions, TransformOptions, QueryBuilder, TransformBuilder>

Type parameters​

NameType
QueryOptionsextends RequestOptions = RecordCacheQueryOptions
TransformOptionsextends RequestOptions = RecordCacheTransformOptions
QueryBuilderRecordQueryBuilder
TransformBuilderRecordTransformBuilder

Hierarchy​

Constructors​

constructor​

• new RecordCache<QueryOptions, TransformOptions, QueryBuilder, TransformBuilder>(settings)

Type parameters​

NameType
QueryOptionsextends RequestOptions = RecordCacheQueryOptions
TransformOptionsextends RequestOptions = RecordCacheTransformOptions
QueryBuilderRecordQueryBuilder<string, RecordIdentity>
TransformBuilderRecordTransformBuilder<string, RecordIdentity, UninitializedRecord>

Parameters​

NameType
settingsRecordCacheSettings<QueryOptions, TransformOptions, QueryBuilder, TransformBuilder>

Inherited from​

Evented.constructor

Defined in​

record-cache/src/record-cache.ts:85

Accessors​

defaultQueryOptions​

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

Returns​

undefined | DefaultRequestOptions<QueryOptions>

Defined in​

record-cache/src/record-cache.ts:187

• set defaultQueryOptions(options): void

Parameters​

NameType
optionsundefined | DefaultRequestOptions<QueryOptions>

Returns​

void

Defined in​

record-cache/src/record-cache.ts:191


defaultTransformOptions​

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

Returns​

undefined | DefaultRequestOptions<TransformOptions>

Defined in​

record-cache/src/record-cache.ts:197

• set defaultTransformOptions(options): void

Parameters​

NameType
optionsundefined | DefaultRequestOptions<TransformOptions>

Returns​

void

Defined in​

record-cache/src/record-cache.ts:203


keyMap​

• get keyMap(): undefined | RecordKeyMap

Returns​

undefined | RecordKeyMap

Defined in​

record-cache/src/record-cache.ts:169


name​

• get name(): undefined | string

Returns​

undefined | string

Defined in​

record-cache/src/record-cache.ts:161


queryBuilder​

• get queryBuilder(): QueryBuilder

Returns​

QueryBuilder

Defined in​

record-cache/src/record-cache.ts:179


schema​

• get schema(): RecordSchema

Returns​

RecordSchema

Defined in​

record-cache/src/record-cache.ts:165


transformBuilder​

• get transformBuilder(): TransformBuilder

Returns​

TransformBuilder

Defined in​

record-cache/src/record-cache.ts:183


validatorFor​

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

Returns​

undefined | ValidatorForFn<StandardValidator | StandardRecordValidator>

Defined in​

record-cache/src/record-cache.ts:173

Methods​

emit​

â–¸ emit(event, ...args): void

Parameters​

NameType
eventEvent
...argsunknown[]

Returns​

void

Inherited from​

Evented.emit

Defined in​

core/dist/modules/evented.d.ts:23


getQueryOptions​

â–¸ getQueryOptions(query, expression?): undefined | QueryOptions

Parameters​

NameType
queryRecordQuery
expression?RecordQueryExpression

Returns​

undefined | QueryOptions

Defined in​

record-cache/src/record-cache.ts:209


getTransformOptions​

â–¸ getTransformOptions(transform, operation?): undefined | TransformOptions

Parameters​

NameType
transformRecordTransform
operation?RecordOperation

Returns​

undefined | TransformOptions

Defined in​

record-cache/src/record-cache.ts:223


listeners​

â–¸ listeners(event): Listener[]

Parameters​

NameType
eventEvent

Returns​

Listener[]

Inherited from​

Evented.listeners

Defined in​

core/dist/modules/evented.d.ts:24


off​

â–¸ off(event, listener?): void

Parameters​

NameType
eventEvent
listener?Listener

Returns​

void

Inherited from​

Evented.off

Defined in​

core/dist/modules/evented.d.ts:21


on​

â–¸ on(event, listener): () => void

Parameters​

NameType
eventEvent
listenerListener

Returns​

fn

â–¸ (): void

Returns​

void

Inherited from​

Evented.on

Defined in​

core/dist/modules/evented.d.ts:20


one​

â–¸ one(event, listener): () => void

Parameters​

NameType
eventEvent
listenerListener

Returns​

fn

â–¸ (): void

Returns​

void

Inherited from​

Evented.one

Defined in​

core/dist/modules/evented.d.ts:22