A NestJS module for Unleash, providing feature flagging with a global Guard and decorators.

Table of Contents

Installation

$ npm i @alpha018/nestjs-unleash-client

Usage

Import The Module

Static Registration

import{UnleashClientModule}from'@alpha018/nestjs-unleash-client';@Module({imports:[// ...UnleashClientModule.forRoot({config:{url:'http://unleash.herokuapp.com/api/',appName:'my-nestjs-app',},isGlobal:true,// Make the module and its providers global}),// ...],})exportclassAppModule{}

Async Registration

import{UnleashClientModule}from'@alpha018/nestjs-unleash-client';import{ConfigModule,ConfigService}from'@nestjs/config';@Module({imports:[// ...UnleashClientModule.forRootAsync({imports:[ConfigModule],useFactory:(configService:ConfigService)=>({config:{url:configService.get('UNLEASH_URL'),appName:configService.get('UNLEASH_APP_NAME'),customHeaders:{Authorization:configService.get('UNLEASH_API_TOKEN')},}}),inject:[ConfigService],isGlobal:true,// Make the module and its providers global}),// ...],})exportclassAppModule{}

Parameter Options

Protecting a Route with a Feature Toggle

import{Controller,Get}from'@nestjs/common';import{UnleashToggle}from'@alpha018/nestjs-unleash-client';@Controller()exportclassAppController{  @Get('hello')  @UnleashToggle('my-feature-toggle')getHello():string{// This route is only accessible if 'my-feature-toggle' is enabled in Unleashreturn'Hello World!';}  @Get('unprotected')getUnprotectedHello():string{// This route is always accessible as it does not have the@UnleashToggle decoratorreturn'This is an unprotected route.';}}

Injecting the Unleash Client

import{Controller,Get}from'@nestjs/common';import{UnleashClientProvider}from'@alpha018/nestjs-unleash-client';@Controller()exportclassAppController{constructor(privatereadonlyunleashProvider:UnleashClientProvider){}  @Get('check')checkFeature(){if(this.unleashProvider.isEnabled('my-other-feature')){// Logic for when the feature is enabledreturn'Feature is enabled!';}else{// Logic for when the feature is disabledreturn'Feature is disabled!';}}}

Resources

Stay in touch

License