Interface: IDocMiddlewareContext<S, T>

Defines the context for document middleware operations.

Type parameters

Table of contents

Properties

• afterWrite
• apply
• commit
• commitSnapshot
• readOp
• readSnapshots
• receive
• reply
• submit
• submitSnapshot

Properties

afterWrite

• afterWrite: IDocSubmitMiddlewareContext<S, T>

Context for after an operation has been successfully written to the database.

apply

• apply: IDocSubmitSnapshotMiddlewareContext<S, T>

Context for applying an operation to the snapshot.

commit

• commit: IDocSubmitMiddlewareContext<S, T>

Context for preparing an operation to be committed to the database.

commitSnapshot

• commitSnapshot: IDocSubmitSnapshotMiddlewareContext<S, T>

Context for preparing a snapshot to be committed to the database.

readOp

• readOp: IDocReadOpMiddlewareContext<T>

Context for when an operation is loaded from the database.

readSnapshots

• readSnapshots: IDocReadSnapshotsMiddlewareContext<S>

Context for when one or more snapshots are loaded from the database for fetch or subscribe operations.

receive

• receive: IDocReceiveMiddlewareContext<T>

Context for when the document receives a message from a client.

reply

• reply: IDocReplyMiddlewareContext<S, T>

Context for when the document is about to send a non-error reply to a client message.

submit

• submit: IDocSubmitMiddlewareContext<S, T>

Context for initiating the submission of an operation.

submitSnapshot

• submitSnapshot: IDocSubmitSnapshotMiddlewareContext<S, T>

Context for initiating the submission of a snapshot.