An interface for querying the status of a Big Segment store.

The Big Segment store is the component that receives information about Big Segments, normally from a database populated by the LaunchDarkly Relay Proxy. Big Segments are a specific type of user segments. For more information, read the LaunchDarkly documentation:

An implementation of this interface is returned by LDClient.bigSegmentStoreStatusProvider. Application code never needs to implement this interface.


  • BigSegmentStoreStatusProvider


  • Gets the current status of the store, if known.

    Returns undefined | BigSegmentStoreStatus

    a BigSegmentStoreStatus, or undefined if the SDK has not yet queried the Big Segment store status

  • Gets the current status of the store, querying it if the status has not already been queried.

    Returns Promise<BigSegmentStoreStatus>

    a Promise for the status of the store

Generated using TypeDoc