@splitsoftware/splitio

What is @splitsoftware/splitio?

@splitsoftware/splitio is a feature flagging and experimentation platform that allows you to manage feature rollouts, run A/B tests, and perform real-time analytics. It helps in delivering features to users in a controlled manner, enabling you to test and iterate quickly.

What are @splitsoftware/splitio's main functionalities?

Feature Flagging

This feature allows you to manage feature flags, enabling or disabling features for specific users or groups. The code sample demonstrates how to initialize the Split.io client and check the status of a feature flag for a user.

const splitio = require('@splitsoftware/splitio');
const factory = splitio({ core: { authorizationKey: 'YOUR_API_KEY' } });
const client = factory.client();

client.on(client.Event.SDK_READY, () => {
  const treatment = client.getTreatment('user123', 'feature_flag_name');
  if (treatment === 'on') {
    // Feature is enabled
  } else {
    // Feature is disabled
  }
});

A/B Testing

This feature allows you to run A/B tests by assigning different treatments (variants) to users. The code sample shows how to determine which variant a user should see based on the experiment configuration.

const splitio = require('@splitsoftware/splitio');
const factory = splitio({ core: { authorizationKey: 'YOUR_API_KEY' } });
const client = factory.client();

client.on(client.Event.SDK_READY, () => {
  const treatment = client.getTreatment('user123', 'experiment_name');
  if (treatment === 'variant_a') {
    // Show variant A
  } else if (treatment === 'variant_b') {
    // Show variant B
  }
});

Real-time Analytics

This feature allows you to track user events and conversions in real-time. The code sample demonstrates how to track a purchase event for a user, which can be used for analytics and reporting.

const splitio = require('@splitsoftware/splitio');
const factory = splitio({ core: { authorizationKey: 'YOUR_API_KEY' } });
const client = factory.client();

client.on(client.Event.SDK_READY, () => {
  client.track('user123', 'conversion', 'purchase', 100);
});

Other packages similar to @splitsoftware/splitio

launchdarkly-node-server-sdk

LaunchDarkly is a feature management platform that provides similar functionality to Split.io, including feature flagging, A/B testing, and real-time analytics. It offers a robust set of tools for managing feature rollouts and experiments.

README

SPLIT SDK for NodeJS

This package provides support for NodeJS implementations. demo!.

Usage

1. npm install --save @splitsoftware/splitio
2. Please use the following snippet in your demo app:

const SPLIT_TOKEN = 'epa57jv812r4602iu43no8jm1h';
const splitEngine = require('@splitsoftware/splitio');

splitEngine(SPLIT_TOKEN).then((/* engine ready */) => {
  console.log('Is "my_sample_feature" available? => ', splitEngine.isOn('my_sample_feature') ? 'yes' : 'no');
})
.catch((error) => {
  console.log('Something went wrong while doing the startup of Split');
});

API

isOn(key :string, featureName :string) :boolean

Given a key and a featureName, ask the engine if the feature is available for the given key.