function
isPageEnvelope
Guard an unknown value as a page envelope.
Arguments
| Argument | Type | Description |
|---|---|---|
value | unknown | The value value. |
Returns
The declared result.
booleanHow it works
The guard validates the envelope and pagination metadata, not each document’s application-specific shape.
Full signature
function isPageEnvelope<Document>(value: unknown): value is PageEnvelope<Document>Related types
PageEnvelopeA paginated REST list response.