MutationEventOutbox | amplify-js

Hierarchy

MutationEventOutbox

Index

Constructors

constructor

Methods

Constructors

constructor

new MutationEventOutbox(schema: InternalSchema, MutationEvent: PersistentModelConstructor<MutationEvent>, modelInstanceCreator: ModelInstanceCreator, ownSymbol: Symbol): MutationEventOutbox

- Defined in packages/datastore/src/sync/outbox.ts:22
Parameters
- schema: InternalSchema
- MutationEvent: PersistentModelConstructor<MutationEvent>
- modelInstanceCreator: ModelInstanceCreator
- ownSymbol: Symbol
Returns MutationEventOutbox

Methods

dequeue

dequeue(storage: StorageClass, record?: PersistentModel, recordOp?: TransformerMutationType): Promise<MutationEvent>

- Defined in packages/datastore/src/sync/outbox.ts:101
Parameters
- storage: StorageClass
- Optional record: PersistentModel
- Optional recordOp: TransformerMutationType
Returns Promise<MutationEvent>

enqueue

enqueue(storage: Storage, mutationEvent: MutationEvent): Promise<void>

- Defined in packages/datastore/src/sync/outbox.ts:31
Parameters
- storage: Storage
- mutationEvent: MutationEvent
Returns Promise<void>

getForModel

getForModel<T>(storage: StorageFacade, model: T, userModelDefinition: SchemaModel): Promise<MutationEvent[]>

- Defined in packages/datastore/src/sync/outbox.ts:131
Type parameters
- T: PersistentModel
Parameters
- storage: StorageFacade
- model: T
- userModelDefinition: SchemaModel
Returns Promise<MutationEvent[]>

getModelIds

getModelIds(storage: StorageFacade): Promise<Set<string>>

- Defined in packages/datastore/src/sync/outbox.ts:151
Parameters
- storage: StorageFacade
Returns Promise<Set<string>>

peek

peek(storage: StorageFacade): Promise<MutationEvent>

- Defined in packages/datastore/src/sync/outbox.ts:123
Doing a peek() implies that the mutation goes "inProgress"

Parameters
- storage: StorageFacade
Returns Promise<MutationEvent>