Skip to content

@nestarc/feature-flag ​

Store feature flags in PostgreSQL and evaluate them in your NestJS application. Use exact-match attributes to target users or tenants, percentage rollouts to release gradually, and @FeatureFlag() to gate routes. An external feature-flag service is not required; NestJS, Prisma, and the other peer dependencies are required.

Start with Installation and first evaluation. It connects database setup, module registration, flag creation, and a request with an expected result. See the agent usage guide for version checks, public imports, and validation steps.

Version scope ​

The published release documented here is 0.6.0, with NestJS 10/11, Prisma 7, and Node.js ^20.19.0, ^22.12.0, or >=24.0.0. The generated API reference is pinned to that release. Upgrading from 0.5.0 requires no feature-flag database migration. See the versioned release notes.

Review rollout assignments when upgrading from 0.5.0

Version 0.6.0 preserves explicit targetingKey, forwards typed-client registry bucketBy, and applies module registry bucketBy in evaluateAll(). These values were previously ignored on those paths, so existing partial-rollout assignments can change. The release also adds invocation bucketBy, direct repository / tenantContextProvider options, and an OpenFeature SDK-compatible boolean provider. Read the version boundary before removing workarounds.

What the package provides ​

NeedEntry point
Gate a route or controllerGuard and decorator
Understand override and rollout precedenceEvaluation and percentage rollouts
Target users, tenants, plans, or regionsAttribute overrides and testing
Share cached flag data between replicasMemory and Redis cache adapters
Manage flags through authenticated endpointsAdmin REST API
Use your own storage or tenant contextCustom backends
Read performance methodology and limitsBenchmark
Integrate from an AI coding agentAgent usage guide

evaluateBoolean() reports the value, source, reason, fallback, and available targeting metadata. defineFlags() and createFeatureFlagClient() provide typed flag keys and defaults. Optional events support evaluation, exposure, and mutation observability. The /testing subpath supplies service stubs; /openfeature supplies an SDK-compatible boolean provider.

For the architectural trade-offs, read NestJS Feature Flags Without External Services. For a longer walkthrough, read Feature Flags for Gradual Rollout.

Documentation site: MIT License. Check each package for its license.