Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace "launchdarkly-node-server-sdk/integrations"

This module contains tools for connecting the LaunchDarkly client to other software, or to test fixtures.

Index

Interfaces

Functions

Functions

FileDataSource

  • Creates an object that allows you to use local files as a source of feature flag state, instead of connecting to LaunchDarkly. This would typically be used in a test environment.

    For more information about this feature, see the SDK features guide.

    To use this component, call FileDataSource(options) and store the result in the updateProcessor property of your LaunchDarkly client configuration:

    const { FileDataSource } = require('launchdarkly-node-server-sdk/integrations');

    const dataSource = FileDataSource({ paths: [ myFilePath ] });
    const config = { updateProcessor: dataSource };

    This will cause the client not to connect to LaunchDarkly to get feature flags, and use the file data instead.

    The client may still make network connections to send analytics events, unless you have disabled this in your configuration by setting LDOptions.sendEvents to false.

    The supported file formats are as follows:

    • JSON files in the format described in the SDK features guide are always supported.
    • The SDK can also read YAML files with an equivalent schema, if you explicitly install the yaml package in your application. This package is not installed by default, to avoid adding to the size of the SDK bundle for this rarely-used feature. The SDK is compatible with any version of the package that supports calling yaml.parse(string) with no custom options.

    Parameters

    Returns object

    An object to put in the updateProcessor property for LDOptions.

TestData

  • A mechanism for providing dynamically updatable feature flag state in a simplified form to an SDK client in test scenarios.

    This function constructs a new TestData object. See TestData for usage details.

    example
    const { TestData } = require('launchdarkly-node-server-sdk/interfaces');

    const td = TestData();
    testData.update(td.flag("flag-key-1").booleanFlag().variationForAll(true));
    const client = new LDClient(sdkKey, { updateProcessor: td });

    // flags can be updated at any time:
    td.update(td.flag("flag-key-2")
        .variationForContext("user", "some-user-key", true)
        .fallthroughVariation(false));

    Returns "launchdarkly-node-server-sdk/integrations".TestData

Generated using TypeDoc