Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@featurevisor/types

featurevisor11.4kMIT1.35.3TypeScript support: included

Common Typescript types for Featurevisor

featurevisor, feature, features, flags, feature flags, feature toggles, feature management, experimentation, experiment, experiments

readme

Featurevisor

Feature management for developers

Manage your feature flags and experiments declaratively from the comfort of your Git workflow.


What is Featurevisor?

Featurevisor is a solution for managing your feature flags, experiments, and remote config. It's built for developers, by developers.

Workflow can be broken down into 3 steps:

  • 1️⃣ Manage feature flags, experiments, and remote config in your Git repository
  • 2️⃣ Trigger CI/CD pipeline to generate and upload datafiles (static JSON files) to your CDN
  • 3️⃣ Fetch and evaluate datafiles in your applications using Featurevisor SDKs

More documentation available at https://featurevisor.com.

Supported features:

  • 🚩 Feature flags: classic on/off switches
  • 🆎 Experimentation: a/b and multivariate tests
  • 👥 Segmentation: reusable conditions for targeting groups of users
  • ↗️ Gradual rollouts: avoid big bang releases, and go from 0% to 100% rollout gradually
  • 🔧 Variables: store key/value pairs for remote config namespaced under each feature
  • 🎯 Consistent bucketing: makes sure same user gets same variation across devices/sessions
  • 🌏 Multiple environments: Go beyond just staging and production to fit your needs
  • 🏷️ Tagging: Load only features relevant to your application, avoiding bloat
  • 👁️ Tracking: Track experiment activations with your favourite analytics tool

SDK support:

Swift and Kotlin SDKs are coming soon for native apps.

Quick start

You are recommended to see a more detailed quick start guide here: https://featurevisor.com/docs/quick-start/.

The whole process can be broken down into 3 steps:

Step 1: Create a Featurevisor project

Use npx to scaffold a new Featurevisor project:

$ mkdir my-featurevisor-project && cd my-featurevisor-project

$ npx @featurevisor/cli init
$ npm install

You can now create and manage your feature flags, experiments, and remote config in this directory expressed as YAMLs.

See the building block guides here:

  • Attributes: building block for conditions
  • Segments: conditions for targeting users
  • Features: feature flags and variables with rollout rules

Step 2: Build and deploy datafiles

Once the project is ready, you can build your datafiles (JSON files containing configuration of your feature flags):

$ npx featurevisor build

You will find the output in dist directory, that you can upload to your CDN.

See further guides here:

A fully functioning example for deploying with Cloudflare and GitHub Actions (for free) is available here.

Step 3: Consume datafiles with Featurevisor SDKs

You can now consume the datafiles from your CDN in your applications directly using Featurevisor SDKs.

For Node.js and browser environments, install the JavaScript SDK:

$ npm install --save @featurevisor/sdk

Now you can initialize the SDK with the URL of your datafile, and evaluate your feature flags:

import { createInstance } from "@featurevisor/sdk";

// Initialize the SDK
const f = createInstance({
  datafileUrl: "https://cdn.yoursite.com/datafile.json",
  onReady: () => console.log("Datafile has been fetched and SDK is ready"),
});

// Evaluate a feature flag
const featureKey = "myFeature";
const context = {
  userId: "user-123",
  country: "nl",
};

const isEnabled = f.isEnabled(featureKey, context);
const variation = f.getVariation(featureKey, context);
const variable  = f.getVariable(featureKey, "someVariableKey", context);

Learn more about SDK usage here: https://featurevisor.com/docs/sdks/.

Packages

Package Version Description
@featurevisor/cli CLI package
@featurevisor/core Core package used by CLI
@featurevisor/react React package
@featurevisor/sdk Universal SDK for both Node.js and browser
@featurevisor/site Static site generator for your project
@featurevisor/types Common typings
@featurevisor/vue Vue.js package

License

MIT © Fahad Heylaal

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

1.35.3 (2025-04-12)

Note: Version bump only for package @featurevisor/types

1.35.0 (2025-03-13)

Features

1.33.0 (2025-03-08)

Features

1.32.0 (2025-02-26)

Features

1.31.0 (2025-02-13)

Features

1.29.2 (2025-01-25)

Note: Version bump only for package @featurevisor/types

1.28.0 (2025-01-21)

Features

1.27.5 (2024-12-21)

Note: Version bump only for package @featurevisor/types

1.3.0 (2024-01-23)

Features

  • allow exposing features with tags + environment combination (#254) (1ae08e7)

1.2.2 (2024-01-17)

Note: Version bump only for package @featurevisor/types

1.2.0 (2024-01-16)

Features

0.69.0 (2023-12-13)

Features

BREAKING CHANGES

  • stable

0.68.0 (2023-12-13)

Features

BREAKING CHANGES

  • stable release

0.67.0 (2023-12-13)

  • feat!: publish with conventional commits preset using Lerna (#234) (0b550e1), closes #234

BREAKING CHANGES

  • trigger stable release

0.66.0 (2023-12-13)

Features

BREAKING CHANGES

  • trigger release
  • trigger stable release
  • trigger stable release

0.65.0 (2023-12-13)

  • feat!: trigger v1 release (#232) (2165101), closes #232

BREAKING CHANGES

  • triggering v1 release

0.64.0 (2023-11-29)

Note: Version bump only for package @featurevisor/types

0.63.0 (2023-11-29)

Features

0.62.0 (2023-11-19)

Features

0.61.0 (2023-11-14)

Note: Version bump only for package @featurevisor/types

0.60.0 (2023-11-07)

Features

0.59.0 (2023-10-31)

Note: Version bump only for package @featurevisor/types

0.58.0 (2023-10-29)

Note: Version bump only for package @featurevisor/types

0.57.0 (2023-10-26)

Note: Version bump only for package @featurevisor/types

0.56.0 (2023-10-25)

Note: Version bump only for package @featurevisor/types

0.55.0 (2023-10-19)

Note: Version bump only for package @featurevisor/types

0.54.0 (2023-10-17)

Note: Version bump only for package @featurevisor/types

0.53.0 (2023-10-13)

Note: Version bump only for package @featurevisor/types

0.52.0 (2023-10-12)

Features

  • add support for null, more specific validation of value type in segment (#170) (16a47c5)

0.51.0 (2023-10-05)

Features

0.50.0 (2023-10-01)

Features

0.49.0 (2023-09-30)

Note: Version bump only for package @featurevisor/types

0.48.0 (2023-09-25)

Features

  • custom parser API for going beyond just YAML files (#158) (3fb0352)

0.47.1 (2023-09-12)

Note: Version bump only for package @featurevisor/types

0.47.0 (2023-09-05)

Features

0.46.0 (2023-08-27)

Note: Version bump only for package @featurevisor/types

0.45.0 (2023-08-20)

Note: Version bump only for package @featurevisor/types

0.44.0 (2023-08-07)

Note: Version bump only for package @featurevisor/types

0.43.0 (2023-08-05)

Features

0.42.0 (2023-07-23)

Features

  • segment testing assertion property updated (#113) (cbf693e)

0.41.0 (2023-07-23)

Note: Version bump only for package @featurevisor/types

0.40.1 (2023-07-23)

Note: Version bump only for package @featurevisor/types

0.40.0 (2023-07-16)

Note: Version bump only for package @featurevisor/types

0.39.0 (2023-07-16)

Note: Version bump only for package @featurevisor/types

0.38.0 (2023-07-16)

Features

0.37.0 (2023-07-14)

Features

  • renamed Attributes (object) to Context (#101) (c392ad5)

0.36.0 (2023-07-13)

Note: Version bump only for package @featurevisor/types

0.35.0 (2023-07-13)

Note: Version bump only for package @featurevisor/types

0.34.0 (2023-07-08)

Note: Version bump only for package @featurevisor/types

0.33.0 (2023-07-06)

Note: Version bump only for package @featurevisor/types

0.32.0 (2023-07-02)

Features

0.31.0 (2023-06-24)

Note: Version bump only for package @featurevisor/types

0.30.0 (2023-06-10)

Note: Version bump only for package @featurevisor/types

0.29.0 (2023-06-10)

Features

  • drop Allocation.percentage in datafiles (#80) (b43da69)

0.28.0 (2023-06-08)

Features

0.27.0 (2023-05-24)

Note: Version bump only for package @featurevisor/types

0.26.0 (2023-05-24)

Note: Version bump only for package @featurevisor/types

0.25.0 (2023-05-22)

Features

0.24.0 (2023-05-21)

Features

0.23.0 (2023-05-20)

Note: Version bump only for package @featurevisor/types

0.22.0 (2023-05-20)

Features

  • state files are now per environment (#72) (925f4cf)

0.21.0 (2023-05-14)

Note: Version bump only for package @featurevisor/types

0.20.0 (2023-05-13)

Features

  • SDK Instance from a single class (#68) (1ab1d49)

0.19.0 (2023-05-13)

Features

0.18.0 (2023-05-12)

Features

0.17.0 (2023-05-12)

Features

0.16.0 (2023-04-30)

Features

  • Mutually exclusive experiments via Groups (#63) (f3c8523)

0.15.0 (2023-04-23)

Note: Version bump only for package @featurevisor/types

0.14.1 (2023-04-22)

Bug Fixes

  • do not require variation type in Feature's YAML (#57) (2e7c0cf)

0.14.0 (2023-04-21)

Note: Version bump only for package @featurevisor/types

0.13.0 (2023-04-19)

Note: Version bump only for package @featurevisor/types

0.12.0 (2023-04-17)

Features

  • Allow overriding variation for specific rules (#51) (e6447df)

0.11.0 (2023-04-17)

Note: Version bump only for package @featurevisor/types

0.10.0 (2023-04-15)

Note: Version bump only for package @featurevisor/types

0.9.0 (2023-04-15)

Note: Version bump only for package @featurevisor/types

0.8.0 (2023-04-09)

Features

0.7.0 (2023-03-25)

Features

0.6.0 (2023-03-25)

Features

  • Introduce new JSON type for variables (#28) (49ff4cb)

0.5.3 (2023-03-25)

Bug Fixes

0.5.0 (2023-03-22)

Features

  • Variable overrides at rule level (#23) (c4792a0)

0.4.0 (2023-03-19)

Note: Version bump only for package @featurevisor/types

0.3.0 (2023-03-17)

Features

0.2.0 (2023-03-16)

Features

0.1.0 (2023-03-05)

Note: Version bump only for package @featurevisor/types

0.0.4 (2023-03-05)

Note: Version bump only for package @featurevisor/types

0.0.3 (2023-03-05)

Bug Fixes

0.0.2 (2023-03-05)

Note: Version bump only for package @featurevisor/types

0.0.1 (2023-03-05)

Bug Fixes