[]
        
(Showing Draft Content)

ReadSnapshotsRequest

Class: ReadSnapshotsRequest<S>

Context object passed to "readSnapshots" middleware functions.

Type parameters

Name
S

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new ReadSnapshotsRequest<S>()

Type parameters

Name
S

Properties

snapshotType

snapshotType: SnapshotTypes

The type of snapshot being read.


snapshots

snapshots: ISnapshot<S>[]

The snapshots being read.

Methods

rejectSnapshotReadSilent

rejectSnapshotReadSilent(snapshot, errorMessage): void

Rejects the read of a specific snapshot silently, preventing its data from being sent to the client. Sets a special error code that avoids passing the error to user code while still performing actions like canceling subscriptions.

Parameters

Name Type Description
snapshot ISnapshot<S> The snapshot to reject.
errorMessage string The reason for rejection.

Returns

void