Skip to content

FlagFactory

Factory that creates FlagBuilder instances seeded with the correct FlagKind and initial type-level config.

Signatures

ts
interface FlagFactory {}

Members

Methods

array

ts
array<E extends FlagConfig>(element: FlagBuilder<E>): FlagBuilder<{ optionalFallback: "empty-array"; presence: "optional"; valueType: E["valueType"][]; }>;

boolean

ts
boolean(): FlagBuilder<{ optionalFallback: "undefined"; presence: "defaulted"; valueType: boolean; }>;

custom

ts
custom<T>(parseFn: FlagParseFn<T>): FlagBuilder<{ optionalFallback: "undefined"; presence: "optional"; valueType: T; }>;

enum

ts
enum<T extends readonly [string, string]>(values: T): FlagBuilder<{ optionalFallback: "undefined"; presence: "optional"; valueType: T[number]; }>;

number

ts
number(): FlagBuilder<{ optionalFallback: "undefined"; presence: "optional"; valueType: number; }>;

string

ts
string(): FlagBuilder<{ optionalFallback: "undefined"; presence: "optional"; valueType: string; }>;

See Also

Released under the MIT License.