@openshift-console/dynamic-plugin-sdk/lib/extensions/feature-flags.d.ts

Provides core APIs, types and utilities used by dynamic plugins at runtime.

import { ExtensionK8sModel } from '../api/common-types';
import { Extension, ExtensionDeclaration, CodeRef } from '../types';
/** Gives full control over Console feature flags. */
export type FeatureFlag = ExtensionDeclaration<'console.flag', {
    /** Used to set/unset arbitrary feature flags. */
    handler: CodeRef<FeatureFlagHandler>;
}>;
/** Adds new Console feature flag driven by the presence of a CRD on the cluster. */
export type ModelFeatureFlag = ExtensionDeclaration<'console.flag/model', {
    /** The name of the flag to set once the CRD is detected. */
    flag: string;
    /** The model which refers to a `CustomResourceDefinition`. */
    model: ExtensionK8sModel;
}>;
/** Gives full control over Console feature flags with hook handlers. */
export type FeatureFlagHookProvider = ExtensionDeclaration<'console.flag/hookProvider', {
    /** Used to set/unset arbitrary feature flags. */
    handler: CodeRef<FeatureFlagHandler>;
}>;
export declare const isFeatureFlag: (e: Extension) => e is FeatureFlag;
export declare const isModelFeatureFlag: (e: Extension) => e is ModelFeatureFlag;
export declare const isFeatureFlagHookProvider: (e: Extension) => e is FeatureFlagHookProvider;
export type SetFeatureFlag = (flag: string, enabled: boolean) => void;
export type FeatureFlagHandler = (callback: SetFeatureFlag) => void;