react-native-worklets/src/featureFlags/types.ts

The React Native multithreading library

'use strict';

import type StaticFeatureFlagsJSON from './staticFlags.json';

export type DynamicFlagsType = {
  EXAMPLE_DYNAMIC_FLAG: boolean;
  init(): void;
  setFlag(name: DynamicFlagName, value: boolean): void;
  getFlag(name: DynamicFlagName): boolean;
};

export type DynamicFlagName = keyof Omit<
  Omit<DynamicFlagsType, 'setFlag' | 'getFlag'>,
  'init'
>;

/**
 * This constant is needed for typechecking and preserving static typechecks in
 * generated .d.ts files. Without it, the static flags resolve to an object
 * without specific keys.
 */
export const DefaultStaticFeatureFlags = {
  RUNTIME_TEST_FLAG: false,
  IOS_DYNAMIC_FRAMERATE_ENABLED: false,
} as const satisfies typeof StaticFeatureFlagsJSON;

export type StaticFeatureFlagsSchema = {
  -readonly [K in keyof typeof DefaultStaticFeatureFlags]: boolean;
};