Class BaseFirstMatchStrategy<TProviderStatus, TProvider>

Base evaluation strategy for multi-provider flag resolution.

This class is intended to be extended by concrete strategies and is not directly usable on its own. Implementations must provide a determineFinalResult method that takes the per-provider results and determines the final flag resolution outcome.

The base class also provides default implementations for shouldEvaluateThisProvider and shouldEvaluateNextProvider that can be used as-is or overridden by subclasses as needed.

Type Parameters

TProviderStatus
TProvider

Hierarchy (view full)

BaseEvaluationStrategy<TProviderStatus, TProvider>
- BaseFirstMatchStrategy

Index

Constructors

constructor

new BaseFirstMatchStrategy<TProviderStatus, TProvider>(statusEnum): BaseFirstMatchStrategy<TProviderStatus, TProvider>
Type Parameters
- TProviderStatus
- TProvider
Parameters
- statusEnum: Record<string, TProviderStatus>
Returns BaseFirstMatchStrategy<TProviderStatus, TProvider>
Inherited from BaseEvaluationStrategy.constructor
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:67

Properties

runMode

runMode: "parallel" | "sequential" = 'sequential'

`Protected`statusEnum

statusEnum: Record<string, TProviderStatus>

Methods

`Protected`collectProviderErrors

collectProviderErrors<T>(resolutions): BaseFinalResult<T, TProviderStatus, TProvider>
Type Parameters
- T extends FlagValue
Parameters
- resolutions: BaseProviderResolutionResult<T, TProviderStatus, TProvider>[]
Returns BaseFinalResult<T, TProviderStatus, TProvider>
Inherited from BaseEvaluationStrategy.collectProviderErrors
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:130

determineFinalResult

determineFinalResult<T>(strategyContext, context, resolutions): BaseFinalResult<T, TProviderStatus, TProvider>
Type Parameters
- T extends FlagValue
Parameters
- strategyContext: BaseStrategyPerProviderContext<TProviderStatus, TProvider>
- context: EvaluationContext
- resolutions: BaseProviderResolutionResult<T, TProviderStatus, TProvider>[]
Returns BaseFinalResult<T, TProviderStatus, TProvider>
Overrides BaseEvaluationStrategy.determineFinalResult
- Defined in packages/shared/src/provider/multi-provider/strategies/first-match-strategy.ts:25

`Protected`hasError

hasError<T>(resolution): resolution is BaseProviderResolutionErrorResult<TProviderStatus, TProvider> | BaseProviderResolutionResultBase<TProvider> & {
    details: ResolutionDetails<T>;
} & {
    details: ResolutionDetails<T> & {
        errorCode: ErrorCode;
    };
}
Type Parameters
- T extends FlagValue
Parameters
- resolution: BaseProviderResolutionResult<T, TProviderStatus, TProvider>
Returns resolution is BaseProviderResolutionErrorResult<TProviderStatus, TProvider> | BaseProviderResolutionResultBase<TProvider> & {
    details: ResolutionDetails<T>;
} & {
    details: ResolutionDetails<T> & {
        errorCode: ErrorCode;
    };
}
Inherited from BaseEvaluationStrategy.hasError
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:111

`Protected`hasErrorWithCode

hasErrorWithCode<T>(resolution, code): boolean
Type Parameters
- T extends FlagValue
Parameters
- resolution: BaseProviderResolutionResult<T, TProviderStatus, TProvider>
- code: ErrorCode
Returns boolean
Inherited from BaseEvaluationStrategy.hasErrorWithCode
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:121

`Protected`resolutionToFinalResult

resolutionToFinalResult<T>(resolution): {
    details: ResolutionDetails<T>;
    provider: TProvider;
    providerName: string;
}
Type Parameters
- T extends FlagValue
Parameters
- resolution: BaseProviderResolutionSuccessResult<T, TProviderStatus, TProvider>
Returns {
    details: ResolutionDetails<T>;
    provider: TProvider;
    providerName: string;
}
- details: ResolutionDetails<T>
- provider: TProvider
- providerName: string
Inherited from BaseEvaluationStrategy.resolutionToFinalResult
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:147

shouldEvaluateNextProvider

shouldEvaluateNextProvider<T>(strategyContext, context, result): boolean
Type Parameters
- T extends FlagValue
Parameters
- strategyContext: BaseStrategyPerProviderContext<TProviderStatus, TProvider>
- context: EvaluationContext
- result: BaseProviderResolutionResult<T, TProviderStatus, TProvider>
Returns boolean
Overrides BaseEvaluationStrategy.shouldEvaluateNextProvider
- Defined in packages/shared/src/provider/multi-provider/strategies/first-match-strategy.ts:11

shouldEvaluateThisProvider

shouldEvaluateThisProvider(strategyContext, _evalContext?): boolean
Parameters
- strategyContext: BaseStrategyPerProviderContext<TProviderStatus, TProvider>
- Optional_evalContext: EvaluationContext
Returns boolean
Inherited from BaseEvaluationStrategy.shouldEvaluateThisProvider
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:69

shouldTrackWithThisProvider

shouldTrackWithThisProvider(strategyContext, _context?, _trackingEventName?, _trackingEventDetails?): boolean
Parameters
- strategyContext: BaseStrategyProviderContext<TProviderStatus, TProvider>
- Optional_context: EvaluationContext
- Optional_trackingEventName: string
- Optional_trackingEventDetails: TrackingEventDetails
Returns boolean
Inherited from BaseEvaluationStrategy.shouldTrackWithThisProvider
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:90

Class BaseFirstMatchStrategy<TProviderStatus, TProvider>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns BaseFirstMatchStrategy<TProviderStatus, TProvider>

Properties

runMode

ProtectedstatusEnum

Methods

ProtectedcollectProviderErrors

Type Parameters

Parameters

Returns BaseFinalResult<T, TProviderStatus, TProvider>

determineFinalResult

Type Parameters

Parameters

Returns BaseFinalResult<T, TProviderStatus, TProvider>

ProtectedhasError

Type Parameters

Parameters

Returns resolution is BaseProviderResolutionErrorResult<TProviderStatus, TProvider> | BaseProviderResolutionResultBase<TProvider> & { details: ResolutionDetails<T>; } & { details: ResolutionDetails<T> & { errorCode: ErrorCode; }; }

ProtectedhasErrorWithCode

Type Parameters

Parameters

Returns boolean

ProtectedresolutionToFinalResult

Type Parameters

Parameters

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

details: ResolutionDetails<T>

provider: TProvider

providerName: string

shouldEvaluateNextProvider

Type Parameters

Parameters

Returns boolean

shouldEvaluateThisProvider

Parameters

Returns boolean

shouldTrackWithThisProvider

Parameters

Returns boolean

Settings

On This Page

`Protected`statusEnum

`Protected`collectProviderErrors

`Protected`hasError

Returns resolution is BaseProviderResolutionErrorResult<TProviderStatus, TProvider> | BaseProviderResolutionResultBase<TProvider> & {
details: ResolutionDetails<T>;
} & {
details: ResolutionDetails<T> & {
errorCode: ErrorCode;
};
}

`Protected`hasErrorWithCode

`Protected`resolutionToFinalResult

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