@webiny/feature-flags NPM

`@webiny/feature-flags`

A small library that provides a simple way to define and read feature flags in a Webiny project.

Installation

npm install --save @webiny/feature-flags

Or if you prefer yarn:

yarn add @webiny/feature-flags

Overview

The @webiny/feature-flags exports a single featureFlags object which contains all of the feature flags initially set via the Webiny project's webiny.project.ts config file, via its featureFlags property.

For example, given the following webiny.project.ts config file;

// webiny.project.ts
export default {
    name: "webiny-js",
    cli: {
        ...
    },
    
    // Feature flags are defined via a simple JavaScript object.
    featureFlags: {
        myCustomFeatureFlag: false,
        someFeature: { enabled: true, myCustomProperty: 123, thisIsJson: "yes"}
    }
};

Within both backend and frontend application code, the featureFlags object can then be read like so:

import { featureFlags } from "@webiny/feature-flags"; 

const useMyCustomFeature = featureFlags.myCustomFeatureFlag;

const someOtherFeatureMyCustomProperty = featureFlags.someFeature.myCustomProperty;

NOTE
Behind the scenes, it's the Webiny CLI that enables the propagation of the featureFlags object into the actual applications. As mentioned, the featureFlags object can be accessed within both backend and frontend application code.

Examples

No additional examples.

Reference

Objects

`featureFlags`

declare let featureFlags: Record<string, any>;

The featureFlags object contains all of the feature flags initially set via the Webiny project's webiny.project.ts config file, via its featureFlags property.

import { featureFlags } from "@webiny/feature-flags";

const useMyCustomFeature = featureFlags.myCustomFeatureFlag;

const someOtherFeatureMyCustomProperty = featureFlags.someFeature.myCustomProperty;

@babel/runtime

@infinitebrahmanuniverse/nolb-_webi @everything-registry/sub-chunk-1008 @webiny/serverless-cms-aws @webiny/app-admin-rmwc @webiny/app-security-access-management @webiny/app-headless-cms

2 days ago

2 days ago

2 days ago

16 days ago

16 days ago

16 days ago

22 days ago

29 days ago

29 days ago

1 month ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

3 months ago

0.0.0-unstable.de38392959

4 months ago

5.38.5-beta.0

4 months ago

0.0.0-unstable.a9593f74dd

4 months ago

5.38.5

4 months ago

5.38.4

4 months ago

5.38.4-beta.0

4 months ago

0.0.0-unstable.2696f9d9e8

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

9 months ago

9 months ago

6 months ago

6 months ago

6 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

7 months ago

7 months ago

8 months ago

9 months ago

7 months ago

8 months ago

9 months ago

7 months ago

8 months ago

8 months ago

7 months ago

7 months ago

0.0.0-unstable.c7dec08bb0

10 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

0.0.0-unstable.acacc54f0e

10 months ago

6 months ago

10 months ago

10 months ago

10 months ago

7 months ago

7 months ago

7 months ago

7 months ago

8 months ago

8 months ago

9 months ago

9 months ago

0.0.0-unstable.8feaff8c32

10 months ago

0.0.0-unstable.99666aeb00

10 months ago

0.0.0-unstable.98511f29f1

10 months ago

0.0.0-unstable.085ff6572f

11 months ago

10 months ago

8 months ago

6 months ago

6 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

11 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

0.0.0-unstable.c59b9cc5b9

12 months ago

0.0.0-unstable.aa00eecd97

12 months ago

0.0.0-unstable.d13302545b

12 months ago

12 months ago

12 months ago

12 months ago

12 months ago

0.0.0-unstable.606fc9c866

1 year ago

0.0.0-unstable.79032b23a5

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.8acc9e8892

1 year ago

0.0.0-unstable.ad3a7a4920

1 year ago

0.0.0-unstable.b6408e0dea

1 year ago

0.0.0-unstable.1145e7667f

1 year ago

0.0.0-unstable.b14eaecf38

1 year ago

0.0.0-unstable.c2780f51fe

1 year ago

0.0.0-unstable.da99e0b846

1 year ago

0.0.0-unstable.9e825fd5fb

1 year ago

0.0.0-unstable.6509387258

1 year ago

0.0.0-unstable.df6d94b531

1 year ago

0.0.0-unstable.b02d94bba0

1 year ago

5.34.8

1 year ago

0.0.0-unstable.496cf268ac

1 year ago

5.34.8-beta.1

1 year ago

0.0.0-unstable.13771d80a8

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.ecd8734205

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.e3f4727c56

1 year ago

5.34.6-beta.3

1 year ago

5.34.6-beta.2

1 year ago

5.34.6-beta.1

1 year ago

0.0.0-unstable.60a863e033

1 year ago

0.0.0-unstable.d65ec29d44

1 year ago

0.0.0-unstable.d7f521b032

1 year ago

0.0.0-unstable.bca7b3e350

1 year ago

5.34.6-beta.0

1 year ago

0.0.0-unstable.2af142b57e

1 year ago

0.0.0-unstable.631e0f3b8d

1 year ago

5.34.5

1 year ago

5.34.5-beta.1

1 year ago

0.0.0-unstable.cc58a6566b

1 year ago

5.34.5-beta.0

1 year ago

0.0.0-unstable.7f63ea0744

1 year ago

5.34.4

1 year ago

5.34.4-beta.0

1 year ago

0.0.0-unstable.3386f66516

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-ee-vpcs.549378cf03

1 year ago

0.0.0-unstable.60e968001a

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.d16f688daf

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

0.0.0-unstable.aad28a72ae

1 year ago

0.0.0-unstable.97a151f74d

1 year ago

0.0.0-unstable.615a930a68

1 year ago

@webiny/feature-flags v5.39.6