mirror of
https://github.com/Unleash/unleash.git
synced 2025-10-27 11:02:16 +01:00
abe160eb7d
We're migrating to ESM, which will allow us to import the latest versions of our dependencies. Co-Authored-By: Christopher Kolstad <chriswk@getunleash.io>
42 lines
2.0 KiB
TypeScript
42 lines
2.0 KiB
TypeScript
/**
|
|
* Generated by Orval
|
|
* Do not edit manually.
|
|
* See `gen:api` script in package.json
|
|
*/
|
|
import type { SdkFlatContextSchema } from './sdkFlatContextSchema.js';
|
|
import type { AdvancedPlaygroundEnvironmentFeatureSchemaStrategies } from './advancedPlaygroundEnvironmentFeatureSchemaStrategies.js';
|
|
import type { AdvancedPlaygroundEnvironmentFeatureSchemaVariant } from './advancedPlaygroundEnvironmentFeatureSchemaVariant.js';
|
|
import type { VariantSchema } from './variantSchema.js';
|
|
|
|
/**
|
|
* A simplified feature flag model intended for the Unleash playground.
|
|
*/
|
|
export interface AdvancedPlaygroundEnvironmentFeatureSchema {
|
|
/** The context to use when evaluating flags */
|
|
context: SdkFlatContextSchema;
|
|
/** The feature's environment. */
|
|
environment: string;
|
|
/** Whether this feature is enabled or not in the current environment.
|
|
If a feature can't be fully evaluated (that is, `strategies.result` is `unknown`),
|
|
this will be `false` to align with how client SDKs treat unresolved feature states. */
|
|
isEnabled: boolean;
|
|
/** Whether the feature is active and would be evaluated in the provided environment in a normal SDK context. */
|
|
isEnabledInCurrentEnvironment: boolean;
|
|
/** The feature's name. */
|
|
name: string;
|
|
/** The ID of the project that contains this feature. */
|
|
projectId: string;
|
|
/** Feature's applicable strategies and cumulative results of the strategies */
|
|
strategies: AdvancedPlaygroundEnvironmentFeatureSchemaStrategies;
|
|
/**
|
|
* The feature variant you receive based on the provided context or the _disabled
|
|
variant_. If a feature is disabled or doesn't have any
|
|
variants, you would get the _disabled variant_.
|
|
Otherwise, you'll get one of the feature's defined variants.
|
|
* @nullable
|
|
*/
|
|
variant: AdvancedPlaygroundEnvironmentFeatureSchemaVariant;
|
|
/** The feature variants. */
|
|
variants: VariantSchema[];
|
|
}
|