@nestarc/safe-response

API reference for @nestarc/safe-response 0.15.0. API response wrapper with Swagger integration, field selection, error catalogs, and i18n support.

Start here

Install the documented release with npm install @nestarc/safe-response@0.15.0. Follow Installation for peer dependencies and application setup, then read Response format for usage decisions and examples.

Choose an import path below to find its exported signatures and types. The root package contains the main application APIs; named subpaths group the additional integrations and utilities. The reference is generated from the published release, with source links pinned to its commit.

Modules

• @nestarc/safe-response/client — Consume response envelopes using success, error, pagination, and metadata types. Type guards such as isSuccess and isError help narrow received responses.
• @nestarc/safe-response — Configure the NestJS response module, response decorators, DTOs, error contracts, and Swagger helpers that produce consistent API envelopes.