# ReadSnapshotsRequest

## Content

# Class: ReadSnapshotsRequest<S\>

Context object passed to "readSnapshots" middleware functions.

## Type parameters

| Name |
| :------ |
| `S` |

## Table of contents

### Constructors

- [constructor](ReadSnapshotsRequest#constructor)

### Properties

- [snapshotType](ReadSnapshotsRequest#snapshottype)
- [snapshots](ReadSnapshotsRequest#snapshots)

### Methods

- [rejectSnapshotReadSilent](ReadSnapshotsRequest#rejectsnapshotreadsilent)

## Constructors

### <a id="constructor" name="constructor"></a> constructor

• **new ReadSnapshotsRequest**<`S`\>()

#### Type parameters

| Name |
| :------ |
| `S` |

## Properties

### <a id="snapshottype" name="snapshottype"></a> snapshotType

• **snapshotType**: [`SnapshotTypes`](../README#snapshottypes)

The type of snapshot being read.

___

### <a id="snapshots" name="snapshots"></a> snapshots

• **snapshots**: [`ISnapshot`](../interfaces/ISnapshot)<`S`\>[]

The snapshots being read.

## Methods

### <a id="rejectsnapshotreadsilent" name="rejectsnapshotreadsilent"></a> 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`](../interfaces/ISnapshot)<`S`\> | The snapshot to reject. |
| `errorMessage` | `string` | The reason for rejection. |

#### Returns

`void`