Skip to content

refactor: rename Flags type to Flagship and prefix exported types #6584

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
git-bruh merged 2 commits into from
Apr 15, 2026
Merged

refactor: rename Flags type to Flagship and prefix exported types #6584

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00c80ad
refactor: rename Flags type to Flagship and prefix exported types
roerohan Apr 15, 2026
dfc3d1a
chore: update generated snapshot
roerohan Apr 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 20 additions & 17 deletions types/defines/flags.d.ts → types/defines/flagship.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,12 @@
* Evaluation context for targeting rules.
* Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
*/
export type EvaluationContext = Record<string, string | number | boolean>;
export type FlagshipEvaluationContext = Record<
string,
string | number | boolean
>;

export interface EvaluationDetails<T> {
export interface FlagshipEvaluationDetails<T> {
flagKey: string;
value: T;
variant?: string | undefined;
Expand All @@ -13,7 +16,7 @@ export interface EvaluationDetails<T> {
errorMessage?: string | undefined;
}

export interface FlagEvaluationError extends Error {}
export interface FlagshipEvaluationError extends Error {}

/**
* Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
Expand All @@ -34,7 +37,7 @@ export interface FlagEvaluationError extends Error {}
* console.log(details.variant, details.reason);
* ```
*/
export declare abstract class Flags {
export declare abstract class Flagship {
/**
* Get a flag value without type checking.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -44,7 +47,7 @@ export declare abstract class Flags {
get(
flagKey: string,
defaultValue?: unknown,
context?: EvaluationContext
context?: FlagshipEvaluationContext
): Promise<unknown>;

/**
Expand All @@ -56,7 +59,7 @@ export declare abstract class Flags {
getBooleanValue(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext
context?: FlagshipEvaluationContext
): Promise<boolean>;

/**
Expand All @@ -68,7 +71,7 @@ export declare abstract class Flags {
getStringValue(
flagKey: string,
defaultValue: string,
context?: EvaluationContext
context?: FlagshipEvaluationContext
): Promise<string>;

/**
Expand All @@ -80,7 +83,7 @@ export declare abstract class Flags {
getNumberValue(
flagKey: string,
defaultValue: number,
context?: EvaluationContext
context?: FlagshipEvaluationContext
): Promise<number>;

/**
Expand All @@ -92,7 +95,7 @@ export declare abstract class Flags {
getObjectValue<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext
context?: FlagshipEvaluationContext
): Promise<T>;

/**
Expand All @@ -104,8 +107,8 @@ export declare abstract class Flags {
getBooleanDetails(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext
): Promise<EvaluationDetails<boolean>>;
context?: FlagshipEvaluationContext
): Promise<FlagshipEvaluationDetails<boolean>>;

/**
* Get a string flag value with full evaluation details.
Expand All @@ -116,8 +119,8 @@ export declare abstract class Flags {
getStringDetails(
flagKey: string,
defaultValue: string,
context?: EvaluationContext
): Promise<EvaluationDetails<string>>;
context?: FlagshipEvaluationContext
): Promise<FlagshipEvaluationDetails<string>>;

/**
* Get a number flag value with full evaluation details.
Expand All @@ -128,8 +131,8 @@ export declare abstract class Flags {
getNumberDetails(
flagKey: string,
defaultValue: number,
context?: EvaluationContext
): Promise<EvaluationDetails<number>>;
context?: FlagshipEvaluationContext
): Promise<FlagshipEvaluationDetails<number>>;

/**
* Get an object flag value with full evaluation details.
Expand All @@ -140,6 +143,6 @@ export declare abstract class Flags {
getObjectDetails<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext
): Promise<EvaluationDetails<T>>;
context?: FlagshipEvaluationContext
): Promise<FlagshipEvaluationDetails<T>>;
}
34 changes: 17 additions & 17 deletions types/generated-snapshot/experimental/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12816,16 +12816,16 @@ declare module "cloudflare:email" {
* Evaluation context for targeting rules.
* Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
*/
type EvaluationContext = Record<string, string | number | boolean>;
interface EvaluationDetails<T> {
type FlagshipEvaluationContext = Record<string, string | number | boolean>;
interface FlagshipEvaluationDetails<T> {
flagKey: string;
value: T;
variant?: string | undefined;
reason?: string | undefined;
errorCode?: string | undefined;
errorMessage?: string | undefined;
}
interface FlagEvaluationError extends Error {}
interface FlagshipEvaluationError extends Error {}
/**
* Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
*
Expand All @@ -12845,7 +12845,7 @@ interface FlagEvaluationError extends Error {}
* console.log(details.variant, details.reason);
* ```
*/
declare abstract class Flags {
declare abstract class Flagship {
/**
* Get a flag value without type checking.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12855,7 +12855,7 @@ declare abstract class Flags {
get(
flagKey: string,
defaultValue?: unknown,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<unknown>;
/**
* Get a boolean flag value.
Expand All @@ -12866,7 +12866,7 @@ declare abstract class Flags {
getBooleanValue(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<boolean>;
/**
* Get a string flag value.
Expand All @@ -12877,7 +12877,7 @@ declare abstract class Flags {
getStringValue(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<string>;
/**
* Get a number flag value.
Expand All @@ -12888,7 +12888,7 @@ declare abstract class Flags {
getNumberValue(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<number>;
/**
* Get an object flag value.
Expand All @@ -12899,7 +12899,7 @@ declare abstract class Flags {
getObjectValue<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<T>;
/**
* Get a boolean flag value with full evaluation details.
Expand All @@ -12910,8 +12910,8 @@ declare abstract class Flags {
getBooleanDetails(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
): Promise<EvaluationDetails<boolean>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<boolean>>;
/**
* Get a string flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12921,8 +12921,8 @@ declare abstract class Flags {
getStringDetails(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
): Promise<EvaluationDetails<string>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<string>>;
/**
* Get a number flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12932,8 +12932,8 @@ declare abstract class Flags {
getNumberDetails(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
): Promise<EvaluationDetails<number>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<number>>;
/**
* Get an object flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12943,8 +12943,8 @@ declare abstract class Flags {
getObjectDetails<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
): Promise<EvaluationDetails<T>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<T>>;
}
/**
* Hello World binding to serve as an explanatory example. DO NOT USE
Expand Down
37 changes: 20 additions & 17 deletions types/generated-snapshot/experimental/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12832,16 +12832,19 @@ export declare type EmailExportedHandler<Env = unknown, Props = unknown> = (
* Evaluation context for targeting rules.
* Keys are attribute names (e.g. "userId", "country"), values are the attribute values.
*/
export type EvaluationContext = Record<string, string | number | boolean>;
export interface EvaluationDetails<T> {
export type FlagshipEvaluationContext = Record<
string,
string | number | boolean
>;
export interface FlagshipEvaluationDetails<T> {
flagKey: string;
value: T;
variant?: string | undefined;
reason?: string | undefined;
errorCode?: string | undefined;
errorMessage?: string | undefined;
}
export interface FlagEvaluationError extends Error {}
export interface FlagshipEvaluationError extends Error {}
/**
* Feature flags binding for evaluating feature flags from a Cloudflare Workers script.
*
Expand All @@ -12861,7 +12864,7 @@ export interface FlagEvaluationError extends Error {}
* console.log(details.variant, details.reason);
* ```
*/
export declare abstract class Flags {
export declare abstract class Flagship {
/**
* Get a flag value without type checking.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12871,7 +12874,7 @@ export declare abstract class Flags {
get(
flagKey: string,
defaultValue?: unknown,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<unknown>;
/**
* Get a boolean flag value.
Expand All @@ -12882,7 +12885,7 @@ export declare abstract class Flags {
getBooleanValue(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<boolean>;
/**
* Get a string flag value.
Expand All @@ -12893,7 +12896,7 @@ export declare abstract class Flags {
getStringValue(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<string>;
/**
* Get a number flag value.
Expand All @@ -12904,7 +12907,7 @@ export declare abstract class Flags {
getNumberValue(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<number>;
/**
* Get an object flag value.
Expand All @@ -12915,7 +12918,7 @@ export declare abstract class Flags {
getObjectValue<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
context?: FlagshipEvaluationContext,
): Promise<T>;
/**
* Get a boolean flag value with full evaluation details.
Expand All @@ -12926,8 +12929,8 @@ export declare abstract class Flags {
getBooleanDetails(
flagKey: string,
defaultValue: boolean,
context?: EvaluationContext,
): Promise<EvaluationDetails<boolean>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<boolean>>;
/**
* Get a string flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12937,8 +12940,8 @@ export declare abstract class Flags {
getStringDetails(
flagKey: string,
defaultValue: string,
context?: EvaluationContext,
): Promise<EvaluationDetails<string>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<string>>;
/**
* Get a number flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12948,8 +12951,8 @@ export declare abstract class Flags {
getNumberDetails(
flagKey: string,
defaultValue: number,
context?: EvaluationContext,
): Promise<EvaluationDetails<number>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<number>>;
/**
* Get an object flag value with full evaluation details.
* @param flagKey The key of the flag to evaluate.
Expand All @@ -12959,8 +12962,8 @@ export declare abstract class Flags {
getObjectDetails<T extends object>(
flagKey: string,
defaultValue: T,
context?: EvaluationContext,
): Promise<EvaluationDetails<T>>;
context?: FlagshipEvaluationContext,
): Promise<FlagshipEvaluationDetails<T>>;
}
/**
* Hello World binding to serve as an explanatory example. DO NOT USE
Expand Down
Loading
Loading