Class FirstSuccessfulStrategy

Evaluates providers in order and returns the first successful result. Any error causes that provider to be skipped.

Hierarchy (view full)

BaseFirstSuccessfulStrategy<ProviderStatus, Provider>
- FirstSuccessfulStrategy

Index

Constructors

constructor

new FirstSuccessfulStrategy(): FirstSuccessfulStrategy
Returns FirstSuccessfulStrategy
Overrides BaseFirstSuccessfulStrategy.constructor
- Defined in packages/web/src/provider/multi-provider/strategies.ts:54

Properties

runMode

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

`Protected`statusEnum

statusEnum: Record<string, ProviderStatus>

Methods

`Protected`collectProviderErrors

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

determineFinalResult

determineFinalResult<T>(strategyContext, context, resolutions): BaseFinalResult<T, ProviderStatus, Provider>
Type Parameters
- T extends FlagValue
Parameters
- strategyContext: BaseStrategyPerProviderContext<ProviderStatus, Provider>
- context: EvaluationContext
- resolutions: BaseProviderResolutionResult<T, ProviderStatus, Provider>[]
Returns BaseFinalResult<T, ProviderStatus, Provider>
Inherited from BaseFirstSuccessfulStrategy.determineFinalResult
- Defined in packages/shared/src/provider/multi-provider/strategies/first-successful-strategy.ts:21

`Protected`hasError

hasError<T>(resolution): resolution is BaseProviderResolutionErrorResult<ProviderStatus, Provider> | BaseProviderResolutionResultBase<Provider> & {
    details: ResolutionDetails<T>;
} & {
    details: ResolutionDetails<T> & {
        errorCode: ErrorCode;
    };
}
Type Parameters
- T extends FlagValue
Parameters
- resolution: BaseProviderResolutionResult<T, ProviderStatus, Provider>
Returns resolution is BaseProviderResolutionErrorResult<ProviderStatus, Provider> | BaseProviderResolutionResultBase<Provider> & {
    details: ResolutionDetails<T>;
} & {
    details: ResolutionDetails<T> & {
        errorCode: ErrorCode;
    };
}
Inherited from BaseFirstSuccessfulStrategy.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, ProviderStatus, Provider>
- code: ErrorCode
Returns boolean
Inherited from BaseFirstSuccessfulStrategy.hasErrorWithCode
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:121

`Protected`resolutionToFinalResult

resolutionToFinalResult<T>(resolution): {
    details: ResolutionDetails<T>;
    provider: Provider;
    providerName: string;
}
Type Parameters
- T extends FlagValue
Parameters
- resolution: BaseProviderResolutionSuccessResult<T, ProviderStatus, Provider>
Returns {
    details: ResolutionDetails<T>;
    provider: Provider;
    providerName: string;
}
- details: ResolutionDetails<T>
- provider: Provider
- providerName: string
Inherited from BaseFirstSuccessfulStrategy.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<ProviderStatus, Provider>
- context: EvaluationContext
- result: BaseProviderResolutionResult<T, ProviderStatus, Provider>
Returns boolean
Inherited from BaseFirstSuccessfulStrategy.shouldEvaluateNextProvider
- Defined in packages/shared/src/provider/multi-provider/strategies/first-successful-strategy.ts:13

shouldEvaluateThisProvider

shouldEvaluateThisProvider(strategyContext, _evalContext?): boolean
Parameters
- strategyContext: BaseStrategyPerProviderContext<ProviderStatus, Provider>
- Optional_evalContext: EvaluationContext
Returns boolean
Inherited from BaseFirstSuccessfulStrategy.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<ProviderStatus, Provider>
- Optional_context: EvaluationContext
- Optional_trackingEventName: string
- Optional_trackingEventDetails: TrackingEventDetails
Returns boolean
Inherited from BaseFirstSuccessfulStrategy.shouldTrackWithThisProvider
- Defined in packages/shared/src/provider/multi-provider/strategies/base-evaluation-strategy.ts:90

Class FirstSuccessfulStrategy

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns FirstSuccessfulStrategy

Properties

runMode

ProtectedstatusEnum

Methods

ProtectedcollectProviderErrors

Type Parameters

Parameters

Returns BaseFinalResult<T, ProviderStatus, Provider>

determineFinalResult

Type Parameters

Parameters

Returns BaseFinalResult<T, ProviderStatus, Provider>

ProtectedhasError

Type Parameters

Parameters

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

ProtectedhasErrorWithCode

Type Parameters

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`statusEnum

`Protected`collectProviderErrors

`Protected`hasError

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

`Protected`hasErrorWithCode

`Protected`resolutionToFinalResult

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