@cspell/cspell-tools
Version:
Tools to assist with the development of cSpell
34 lines • 1.15 kB
TypeScript
export interface FeatureFlag {
name: string;
description: string;
}
type FlagTypes = string | boolean;
/**
* Feature Flags are used to turn on/off features.
* These are primarily used before a feature has been fully released.
*/
export declare class FeatureFlags {
private flags;
private flagValues;
constructor(flags?: FeatureFlag[]);
register(flag: FeatureFlag): this;
register(name: string, description: string): this;
registerFeatures(flags: FeatureFlag[]): this;
getFlag(flag: string): FlagTypes | undefined;
getFlagBool(flag: string): boolean | undefined;
setFlag(flag: string, value?: FlagTypes): this;
getFlagInfo(flag: string): FeatureFlag | undefined;
getFlags(): FeatureFlag[];
getFlagValues(): Map<string, FlagTypes>;
reset(): this;
help(): string;
fork(): FeatureFlags;
}
export declare class UnknownFeatureFlagError extends Error {
readonly flag: string;
constructor(flag: string);
}
export declare function getSystemFeatureFlags(): FeatureFlags;
export declare function createFeatureFlags(): FeatureFlags;
export {};
//# sourceMappingURL=FeatureFlags.d.ts.map