Class ComparisonStrategy

Evaluate all providers in parallel and compare the results. If the values agree, return the value If the values disagree, return the value from the configured "fallback provider" and execute the "onMismatch" callback if defined

Hierarchy (view full)

BaseEvaluationStrategy
- ComparisonStrategy

Index

Constructors

constructor

new ComparisonStrategy(fallbackProvider, onMismatch?): ComparisonStrategy
Parameters
- fallbackProvider: Provider
- OptionalonMismatch: ((resolutions: ProviderResolutionResult<FlagValue>[]) => void)
  - - (resolutions): void
    - Parameters
      resolutions: ProviderResolutionResult<FlagValue>[]
      Returns void
Returns ComparisonStrategy
Overrides BaseEvaluationStrategy.constructor
- Defined in packages/server/src/provider/multi-provider/strategies/comparison-strategy.ts:21

Properties

runMode

runMode: "parallel" = ...

Methods

`Protected`collectProviderErrors

collectProviderErrors<T>(resolutions): FinalResult<T>
Type Parameters
- T extends FlagValue
Parameters
- resolutions: ProviderResolutionResult<T>[]
Returns FinalResult<T>
Inherited from BaseEvaluationStrategy.collectProviderErrors
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:112

determineFinalResult

determineFinalResult<T>(strategyContext, context, resolutions): FinalResult<T>
Type Parameters
- T extends FlagValue
Parameters
- strategyContext: StrategyPerProviderContext
- context: EvaluationContext
- resolutions: ProviderResolutionResult<T>[]
Returns FinalResult<T>
Overrides BaseEvaluationStrategy.determineFinalResult
- Defined in packages/server/src/provider/multi-provider/strategies/comparison-strategy.ts:28

`Protected`hasError

hasError(resolution): resolution is ProviderResolutionErrorResult | ProviderResolutionResultBase & {
    details: ResolutionDetails<FlagValue>;
} & {
    details: ResolutionDetails<FlagValue> & {
        errorCode: ErrorCode;
    };
}
Parameters
- resolution: ProviderResolutionResult<FlagValue>
Returns resolution is ProviderResolutionErrorResult | ProviderResolutionResultBase & {
    details: ResolutionDetails<FlagValue>;
} & {
    details: ResolutionDetails<FlagValue> & {
        errorCode: ErrorCode;
    };
}
Inherited from BaseEvaluationStrategy.hasError
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:98

`Protected`hasErrorWithCode

hasErrorWithCode(resolution, code): boolean
Parameters
- resolution: ProviderResolutionResult<FlagValue>
- code: ErrorCode
Returns boolean
Inherited from BaseEvaluationStrategy.hasErrorWithCode
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:106

`Protected`resolutionToFinalResult

resolutionToFinalResult<T>(resolution): {
    details: ResolutionDetails<T>;
    provider: Provider;
    providerName: string;
}
Type Parameters
- T extends FlagValue
Parameters
- resolution: ProviderResolutionSuccessResult<T>
Returns {
    details: ResolutionDetails<T>;
    provider: Provider;
    providerName: string;
}
- details: ResolutionDetails<T>
- provider: Provider
- providerName: string
Inherited from BaseEvaluationStrategy.resolutionToFinalResult
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:127

shouldEvaluateNextProvider

shouldEvaluateNextProvider<T>(_strategyContext?, _context?, _result?): boolean
Type Parameters
- T extends FlagValue
Parameters
- Optional_strategyContext: StrategyPerProviderContext
- Optional_context: EvaluationContext
- Optional_result: ProviderResolutionResult<T>
Returns boolean
Inherited from BaseEvaluationStrategy.shouldEvaluateNextProvider
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:69

shouldEvaluateThisProvider

shouldEvaluateThisProvider(strategyContext, _evalContext?): boolean
Parameters
- strategyContext: StrategyPerProviderContext
- Optional_evalContext: EvaluationContext
Returns boolean
Inherited from BaseEvaluationStrategy.shouldEvaluateThisProvider
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:59

shouldTrackWithThisProvider

shouldTrackWithThisProvider(strategyContext, _context?, _trackingEventName?, _trackingEventDetails?): boolean
Parameters
- strategyContext: StrategyProviderContext
- Optional_context: EvaluationContext
- Optional_trackingEventName: string
- Optional_trackingEventDetails: TrackingEventDetails
Returns boolean
Inherited from BaseEvaluationStrategy.shouldTrackWithThisProvider
- Defined in packages/server/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:77

Class ComparisonStrategy

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Parameters

Returns void

Returns ComparisonStrategy

Properties

runMode

Methods

ProtectedcollectProviderErrors

Type Parameters

Parameters

Returns FinalResult<T>

determineFinalResult

Type Parameters

Parameters

Returns FinalResult<T>

ProtectedhasError

Parameters

Returns resolution is ProviderResolutionErrorResult | ProviderResolutionResultBase & { details: ResolutionDetails<FlagValue>; } & { details: ResolutionDetails<FlagValue> & { errorCode: ErrorCode; }; }

ProtectedhasErrorWithCode

Parameters

Returns boolean

ProtectedresolutionToFinalResult

Type Parameters

Parameters

Returns { details: ResolutionDetails<T>; provider: Provider; providerName: string; }

details: ResolutionDetails<T>

provider: Provider

providerName: string

shouldEvaluateNextProvider

Type Parameters

Parameters

Returns boolean

shouldEvaluateThisProvider

Parameters

Returns boolean

shouldTrackWithThisProvider

Parameters

Returns boolean

Settings

On This Page

`Protected`collectProviderErrors

`Protected`hasError

Returns resolution is ProviderResolutionErrorResult | ProviderResolutionResultBase & {
details: ResolutionDetails<FlagValue>;
} & {
details: ResolutionDetails<FlagValue> & {
errorCode: ErrorCode;
};
}

`Protected`hasErrorWithCode

`Protected`resolutionToFinalResult

Returns {
details: ResolutionDetails<T>;
provider: Provider;
providerName: string;
}