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
FisErrorEnvelope

Go packages

riducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestconformance

Official adapters

postgressqlitemongodbstorage/localstorage/s3

Official plugins

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

TypeScript packages

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

Tooling

ridu CLI
All@riducms/protocolriducorefieldoperationqueryschemastorestoragemigrationmigration/payloadprotocol (Go)plugintestpostgressqlitemongodbgraphqlmcprichtextseoformbuilderstorage/localstorage/s3conformance@riducms/sdk@riducms/sveltekit@riducms/plugin@riducms/build@riducms/ui@riducms/plugin-richtext@riducms/plugin-seo@riducms/plugin-form-builder@riducms/plugin-graphql@riducms/admin@riducms/translations@riducms/cli/runridu CLI
All 160CollectionSelectionEnvelopeSchemaScalarLiteralSessionTransportisValidationIssueisErrorEnvelopeerrorPayloadisPageEnvelopebindSchemaManifest

function

isErrorEnvelope

Guard an unknown value as a complete error envelope.

ArgumentsReturnsHow it worksFull signature

Arguments

ArgumentTypeDescription
valueunknownThe value value.

Returns

The declared result.

boolean

How it works

The guard checks known error codes, integer status, message, optional request ID, and every validation issue. details remains intentionally open.

Full signature

function isErrorEnvelope(value: unknown): value is ErrorEnvelope

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

Related types

  • ErrorEnvelope

    The stable REST error envelope.