Usage

Validate a configuration in an app-development tool.

This type is used by config.resolveConfig

tsx
// Validate a configuration in an app-development tool.
import { resolveConfig, SETTING_DEFAULTS, IOS_BACKGROUND_MODES } from 'kuito/config';

const config = resolveConfig(
  {
    name: 'Notes',
    ios: { bundleIdentifier: 'com.example.notes' },
    android: { applicationId: 'com.example.notes' },
    environments: { staging: { idSuffix: '.staging' } },
  },
  '/project/kuito.config.ts',
  'staging',
);
console.log(config.ios.bundleIdentifier, config.splash, config.icon);
console.log(SETTING_DEFAULTS.minSdk, IOS_BACKGROUND_MODES);

Type declaration

ts
export interface SplashLook {
  logo: IconSource;
  logoWidth: number;
  /** `#RRGGBB`. */
  background: string;
  brand: IconSource | null;
  dark: { logo: IconSource | null; background: string | null; brand: IconSource | null };
}

Members 5

NameTypeRequiredDescription
logoWidthnumberYes—
backgroundstringYes#RRGGBB.
brandIconSourceYes—
dark{ logo: IconSource | null; background: string | null; brand: IconSource | null;}Yes—
dark — nested fields

dark fields

NameTypeRequiredDescription
logoIconSourceYes—
backgroundstringYes—
brandIconSourceYes—
Generated from the public TypeScript declarations: signatures, props and defaults come from the checked source, descriptions from its JSDoc. No defaults are invented.