Class Flagsmith

constructor

• new Flagsmith(data?): Flagsmith

• A Flagsmith client.

  Provides an interface for interacting with the Flagsmith http API. Basic Usage::

  import flagsmith from Flagsmith const flagsmith = new Flagsmith({environmentKey: ''}); const environmentFlags = flagsmith.getEnvironmentFlags(); const featureEnabled = environmentFlags.isFeatureEnabled('foo'); const identityFlags = flagsmith.getIdentityFlags('identifier', {'foo': 'bar'}); const featureEnabledForIdentity = identityFlags.isFeatureEnabled("foo")

  Parameters

  • Optional data: FlagsmithConfig

  Returns Flagsmith

close

• close(): Promise<void>

• Returns Promise<void>

getEnvironmentFlags

• getEnvironmentFlags(): Promise<Flags>

• Get all the default for flags for the current environment.

  Returns Promise<Flags>

  Flags object holding all the flags for the current environment.

getIdentityFlags

• getIdentityFlags(identifier, traits?, transient?): Promise<Flags>

• Get all the flags for the current environment for a given identity. Will also upsert all traits to the Flagsmith API for future evaluations. Providing a trait with a value of None will remove the trait from the identity if it exists.

  Parameters

  • identifier: string

    a unique identifier for the identity in the current environment, e.g. email address, username, uuid

  • Optional traits: {
        [key: string]: FlagsmithTraitValue | ITraitConfig;
    }

    • [key: string]: FlagsmithTraitValue | ITraitConfig

  • Optional transient: boolean

  Returns Promise<Flags>

  Flags object holding all the flags for the given identity.

getIdentitySegments

• getIdentitySegments(identifier, traits?): Promise<SegmentModel[]>

• Get the segments for the current environment for a given identity. Will also upsert all traits to the Flagsmith API for future evaluations. Providing a trait with a value of None will remove the trait from the identity if it exists.

  Parameters

  • identifier: string

    a unique identifier for the identity in the current environment, e.g. email address, username, uuid

  • Optional traits: {
        [key: string]: any;
    }

    • [key: string]: any

  Returns Promise<SegmentModel[]>

  Segments that the given identity belongs to.

updateEnvironment

• updateEnvironment(): Promise<void>

• Updates the environment state for local flag evaluation. Sets a local promise to prevent race conditions in getIdentityFlags / getIdentitySegments. You only need to call this if you wish to bypass environmentRefreshIntervalSeconds.

  Returns Promise<void>

Optional agent

Optional analyticsUrl

Optional apiUrl

Optional customHeaders

Optional defaultFlagHandler

enableAnalytics

Optional enableLocalEvaluation

environment

Optional environmentDataPollingManager

Optional environmentFlagsUrl

Optional environmentKey

environmentRefreshIntervalSeconds

Optional environmentUrl

Optional identitiesUrl

Optional identitiesWithOverridesByIdentifier

Optional offlineHandler

offlineMode

Optional requestTimeoutMs

Optional retries