Class Feature

Represents a single feature flag and provides evaluation logic based on context.

The Feature class is the core component for determining if a feature is enabled for a specific user or device, considering rollout strategies, conditions, and release dates.

Example

const feature = new Feature(featureData, context);
const isEnabled = await feature.getIsEnabled();

Implements

IFeatureClass

Index

Constructors

constructor

Methods

didUserRegisterBeforeFeatureRelease evalateConditions evaluateConditionWithDetails evaluateInPlayground evaluateWithDetails getIsDeviceLevelEnabled getIsEnabled getIsGlobal getIsReleaseDatePassed getRaw getRolloutEvaluation hasPercentageOverflow updateDeviceContext updateUserContext

Constructors

constructor

new Feature(featureData: FeatureData, context: FeatureContext): Feature
Creates a new Feature instance for evaluation.
Parameters
- featureData: FeatureData
  The raw feature flag configuration data
- context: FeatureContext
  The evaluation context (user, device, etc.)
Returns Feature
- Defined in feature.ts:64

Methods

didUserRegisterBeforeFeatureRelease

didUserRegisterBeforeFeatureRelease(): Promise<boolean>
Specific check for user registration date relative to feature release date.

Returns Promise<boolean>
Promise resolving to true if user registered before the feature release
Example
```
const isEarlyAdopter = await feature.didUserRegisterBeforeFeatureRelease();
```
- Defined in feature.ts:306

evalateConditions

evalateConditions(): Promise<ConditionEvaluationResult>
Evaluates only the feature conditions.

Returns Promise<ConditionEvaluationResult>
Promise resolving to the condition evaluation result
Example
```
const result = await feature.evalateConditions();
if (!result.success) {
  console.log('Failed condition:', result.failedCondition);
}
```
Implementation of IFeatureClass.evalateConditions
- Defined in feature.ts:288

evaluateConditionWithDetails

evaluateConditionWithDetails(
condition: FeatureCondition,
): Promise<ConditionEvaluationResult>
Internal
Internal recursive method to evaluate a complex condition.
Parameters
- condition: FeatureCondition
  The feature condition or group of conditions
Returns Promise<ConditionEvaluationResult>
Detailed condition evaluation result
- Defined in feature.ts:323

evaluateInPlayground

evaluateInPlayground(
options: { cleanupLocalFeatureCache: boolean },
): Promise<FeatureEvaluationResult>
Internal
Specialized evaluation for the feature playground environment.

Optionally cleans up local cache before evaluating.
Parameters
- options: { cleanupLocalFeatureCache: boolean }
  Playground options
Returns Promise<FeatureEvaluationResult>
Evaluation result with details
Implementation of IFeatureClass.evaluateInPlayground
- Defined in feature.ts:551

evaluateWithDetails

evaluateWithDetails(): Promise<FeatureEvaluationResult>
Provides a full evaluation of the feature with detailed reasoning.

Use this when you need to know why a feature is enabled or disabled, such as for debugging or in the feature flag playground.

Returns Promise<FeatureEvaluationResult>
Detailed evaluation result including reason, condition match status, etc.
Example
```
const details = await feature.evaluateWithDetails();
console.log(`Feature enabled: ${details.isEnabled}. Reason: ${details.reason}`);
```
Implementation of IFeatureClass.evaluateWithDetails
- Defined in feature.ts:480

getIsDeviceLevelEnabled

getIsDeviceLevelEnabled(): boolean | null
Internal
Returns the device-level enabled status if set in local cache.

Returns boolean | null
True if enabled, false if disabled, null if not in cache
Implementation of IFeatureClass.getIsDeviceLevelEnabled
- Defined in feature.ts:236

getIsEnabled

getIsEnabled(): Promise<boolean>
Core evaluation method to check if the feature is enabled for the current context.

Considers enabled flag, release date, evaluation conditions, and rollout strategy.

Returns Promise<boolean>
Promise resolving to the final enabled status
Example
```
const isEnabled = await feature.getIsEnabled();
```
Implementation of IFeatureClass.getIsEnabled
- Defined in feature.ts:254

getIsGlobal

getIsGlobal(): boolean
Internal
Checks if the feature data came from the global workspace as a fallback.

Returns boolean
True if global data
Implementation of IFeatureClass.getIsGlobal
- Defined in feature.ts:119

getIsReleaseDatePassed

getIsReleaseDatePassed(): boolean
Checks if the feature's release date has passed.

Returns boolean
True if release date is in the past or not set
Example
```
if (!feature.getIsReleaseDatePassed()) {
  console.log('Feature is not yet released');
}
```
Implementation of IFeatureClass.getIsReleaseDatePassed
- Defined in feature.ts:271

getRaw

getRaw(): FeatureData
Retrieves the raw feature configuration data.

Returns FeatureData
The feature flag data
Implementation of IFeatureClass.getRaw
- Defined in feature.ts:108

getRolloutEvaluation

getRolloutEvaluation(
    isBaselineRollout: boolean,
): Promise<
    {
        isEnabled: boolean;
        reason: string;
        rolloutApplied?: {
            evaluatedValue?: number;
            matchedStep?: { date: string; percentage: number };
            type: "percentage" | "step" | null;
            value: number;
        };
    },
>
Internal
Evaluates the rollout strategy specifically.
Parameters
- isBaselineRollout: boolean
  Whether to force 100% rollout (used when conditions are met but overflow is present)
Returns Promise<
    {
        isEnabled: boolean;
        reason: string;
        rolloutApplied?: {
            evaluatedValue?: number;
            matchedStep?: { date: string; percentage: number };
            type: "percentage" | "step" | null;
            value: number;
        };
    },
>
Evaluation result with enabled status and reason
Implementation of IFeatureClass.getRolloutEvaluation
- Defined in feature.ts:148

hasPercentageOverflow

hasPercentageOverflow(): boolean
Internal
Determines if the current rollout percentage configuration is invalid (over 100%).

Returns boolean
True if percentage exceeds 100
- Defined in feature.ts:130

updateDeviceContext

updateDeviceContext(deviceContext: Partial<DeviceContext>): void
Updates the device context for the feature evaluation.
Parameters
- deviceContext: Partial<DeviceContext>
  Partial device context to update
Returns void
Example
```
feature.updateDeviceContext({ appVersion: '2.5.0' });
```
Implementation of IFeatureClass.updateDeviceContext
- Defined in feature.ts:96

updateUserContext

updateUserContext(userContext: Partial<UserContext>): void
Updates the user context for the feature evaluation.
Parameters
- userContext: Partial<UserContext>
  Partial user context to update
Returns void
Example
```
feature.updateUserContext({ customAttributes: { tier: 'premium' } });
```
Implementation of IFeatureClass.updateUserContext
- Defined in feature.ts:79

Class Feature

Example

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Feature

Methods

didUserRegisterBeforeFeatureRelease

Returns Promise<boolean>

Example

evalateConditions

Returns Promise<ConditionEvaluationResult>

Example

evaluateConditionWithDetails

Parameters

Returns Promise<ConditionEvaluationResult>

evaluateInPlayground

Parameters

Returns Promise<FeatureEvaluationResult>

evaluateWithDetails

Returns Promise<FeatureEvaluationResult>

Example

getIsDeviceLevelEnabled

Returns boolean | null

getIsEnabled

Returns Promise<boolean>

Example

getIsGlobal

Returns boolean

getIsReleaseDatePassed

Returns boolean

Example

getRaw

Returns FeatureData

getRolloutEvaluation

Parameters

Returns Promise< { isEnabled: boolean; reason: string; rolloutApplied?: { evaluatedValue?: number; matchedStep?: { date: string; percentage: number }; type: "percentage" | "step" | null; value: number; }; },>

hasPercentageOverflow

Returns boolean

updateDeviceContext

Parameters

Returns void

Example

updateUserContext

Parameters

Returns void

Example

Settings

On This Page

Returns Promise<
{
isEnabled: boolean;
reason: string;
rolloutApplied?: {
evaluatedValue?: number;
matchedStep?: { date: string; percentage: number };
type: "percentage" | "step" | null;
value: number;
};
},
>