Skip to main content
Version: 0.17

Interface: AsyncRecordAccessor

Hierarchy​

Implemented by​

Properties​

keyMap​

• Optional keyMap: RecordKeyMap

Inherited from​

BaseRecordAccessor.keyMap

Defined in​

record-cache/src/record-accessor.ts:21


name​

• Optional name: string

Inherited from​

BaseRecordAccessor.name

Defined in​

record-cache/src/record-accessor.ts:20


schema​

• schema: RecordSchema

Inherited from​

BaseRecordAccessor.schema

Defined in​

record-cache/src/record-accessor.ts:22

Methods​

addInverseRelationshipsAsync​

â–¸ addInverseRelationshipsAsync(relationships): Promise<void>

Parameters​

NameType
relationshipsRecordRelationshipIdentity[]

Returns​

Promise<void>

Defined in​

record-cache/src/record-accessor.ts:95


applyRecordChangesetAsync​

â–¸ applyRecordChangesetAsync(changeset): Promise<void>

Parameters​

NameType
changesetRecordChangeset

Returns​

Promise<void>

Defined in​

record-cache/src/record-accessor.ts:101


getInverseRelationshipsAsync​

â–¸ getInverseRelationshipsAsync(recordIdentityOrIdentities): Promise<RecordRelationshipIdentity[]>

Parameters​

NameType
recordIdentityOrIdentitiesRecordIdentity | RecordIdentity[]

Returns​

Promise<RecordRelationshipIdentity[]>

Defined in​

record-cache/src/record-accessor.ts:82


getRecordAsync​

â–¸ getRecordAsync(recordIdentity): Promise<undefined | InitializedRecord>

Parameters​

NameType
recordIdentityRecordIdentity

Returns​

Promise<undefined | InitializedRecord>

Defined in​

record-cache/src/record-accessor.ts:68


getRecordsAsync​

â–¸ getRecordsAsync(typeOrIdentities?): Promise<InitializedRecord[]>

Parameters​

NameType
typeOrIdentities?string | RecordIdentity[]

Returns​

Promise<InitializedRecord[]>

Defined in​

record-cache/src/record-accessor.ts:71


getRelatedRecordAsync​

â–¸ getRelatedRecordAsync(identity, relationship): Promise<undefined | null | RecordIdentity>

Parameters​

NameType
identityRecordIdentity
relationshipstring

Returns​

Promise<undefined | null | RecordIdentity>

Defined in​

record-cache/src/record-accessor.ts:74


getRelatedRecordsAsync​

â–¸ getRelatedRecordsAsync(identity, relationship): Promise<undefined | RecordIdentity[]>

Parameters​

NameType
identityRecordIdentity
relationshipstring

Returns​

Promise<undefined | RecordIdentity[]>

Defined in​

record-cache/src/record-accessor.ts:78


removeInverseRelationshipsAsync​

â–¸ removeInverseRelationshipsAsync(relationships): Promise<void>

Parameters​

NameType
relationshipsRecordRelationshipIdentity[]

Returns​

Promise<void>

Defined in​

record-cache/src/record-accessor.ts:98


removeRecordAsync​

â–¸ removeRecordAsync(recordIdentity): Promise<undefined | InitializedRecord>

Parameters​

NameType
recordIdentityRecordIdentity

Returns​

Promise<undefined | InitializedRecord>

Defined in​

record-cache/src/record-accessor.ts:89


removeRecordsAsync​

â–¸ removeRecordsAsync(recordIdentities): Promise<InitializedRecord[]>

Parameters​

NameType
recordIdentitiesRecordIdentity[]

Returns​

Promise<InitializedRecord[]>

Defined in​

record-cache/src/record-accessor.ts:92


setRecordAsync​

â–¸ setRecordAsync(record): Promise<void>

Parameters​

NameType
recordInitializedRecord

Returns​

Promise<void>

Defined in​

record-cache/src/record-accessor.ts:87


setRecordsAsync​

â–¸ setRecordsAsync(records): Promise<void>

Parameters​

NameType
recordsInitializedRecord[]

Returns​

Promise<void>

Defined in​

record-cache/src/record-accessor.ts:88