Skip to content
DocsReference
DocsReferenceGitHub

Search Ridu documentation

tab controls

Loading search…

Search will be ready in a moment.

No matching results

Try a different term or search every section.

Loading search.

Preparing index…View all results →↑↓ move↵ openesc close
Get started
Modules/@riducms/protocol
FisPageEnvelope

Go packages

riducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

graphqlmcprichtextseoformbuilder@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder

TypeScript packages

@riducms/sdk@riducms/protocol@riducms/plugin@riducms/build@riducms/ui@riducms/admin@riducms/translations@riducms/cli/run

Tooling

ridu CLI
All@riducms/protocolriducorefieldqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sdk@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 110JoinMutationEnvelopeisValidationIssueisErrorEnvelopeerrorPayloadisPageEnvelopeValidationIssueErrorPayloadErrorEnvelope

function

isPageEnvelope

function isPageEnvelope<Document>(value: unknown): value is PageEnvelope<Document>

Guard an unknown value as a page envelope.

Source packages/protocol/src/index.ts:54

@param value
The value value.
@returns
The declared result.

The guard validates the envelope and pagination metadata, not each document’s application-specific shape.

Related types

  • PageEnvelope

    A paginated REST list response.