config.Environment — Kuito Documentation

Usage

Fail builds on a fallback

tsx

import type { KuitoConfig } from 'kuito/config';

export default {
  name: 'MyApp',
  ios: { bundleIdentifier: 'com.example.myapp' },
  android: { applicationId: 'com.example.myapp' },
  strict: true,
} satisfies KuitoConfig;

Type declaration

export type Environment = Overrides<Settings> & {
  /** Appended to the bundle id and applicationId, so environments install side by side. */
  idSuffix?: string;
};

Members 19

Name	Type	Required	Description
`name`	`string`	No	Shown under the app icon.
`version`	`string`	No	What users see: up to three numbers, like 1.2.0. Defaults to 1.0.0.
`buildNumber`	`number`	No	What the stores order builds by; raise it for every upload. Defaults to 1.
`icon`	`string`	No	A square PNG of at least 1024×1024, relative to kuito.config.ts.
`orientation`	`Orientation`	No	The orientations the app runs in. `default` follows the device.
`colorScheme`	`ColorScheme`	No	`light` or `dark` ignores the system setting, as CSS's `color-scheme`.
`backgroundColor`	`string`	No	The root window's color, behind the app, like `#1E88E5`.
`statusBar`	`Overrides<{ style?: StatusBarStyle; hidden?: boolean;}>`	No	The status bar at launch; `SystemBars` changes it at run time.
`urlSchemes`	`string[]`	No	Schemes that open the app, like `myapp` for `myapp://show/42` (docs/linking.md).
`linkDomains`	`string[]`	No	Web domains whose https links open the app, like `example.com`: universal links on iOS, verified app links on Android (docs/linking.md).
`ios`	`Overrides<{ bundleIdentifier: string; icon?: { light?: string; dark?: string; tinted?: string; }; supportsTablet?: boolean; requiresFullScreen?: boolean; deploymentTarget?: string; teamId?: string; associatedDomains?: string[]; pushEnvironment?: PushEnvironment; backgroundModes?: IOSBackgroundMode[]; infoPlist?: PlistDictionary; entitlements?: PlistDictionary;}>`	No	—
`android`	`Overrides<{ applicationId: string; adaptiveIcon?: { foreground?: string; background?: string; monochrome?: string; }; softInputMode?: SoftInputMode; minSdk?: number; signing?: { keystore?: string; keyAlias?: string; }; manifest?: AndroidManifestSettings; theme?: Record<string, string>;}>`	No	—
`permissions`	`Overrides<KuitoPermissions>`	No	The permissions the app asks for (docs/permissions.md); none when absent.
`backgroundTasks`	`string[]`	No	Names of the tasks the OS may run in the background (docs/background-tasks.md). An environment's list replaces this one.
`fonts`	`(string \| KuitoFont)[]`	No	.ttf and .otf files `fontFamily` takes (docs/fonts.md), relative to kuito.config.ts. Each file's family, weight and style are read from it; an object sets them instead.
`splash`	`Overrides<KuitoSplash>`	No	The launch screen, and the view the app hands off from (docs/splash.md).
`updates`	`Overrides<{ url: string; publicKey: string;}>`	No	Over-the-air updates of a release build (docs/updates.md): where its shell looks for them, and the key their signatures are checked with. Absent, a release build takes none.
`strict`	`boolean`	No	Code that reads or moves what lives on the UI thread but has to run on the JS thread fails the build, instead of showing in the placement report (docs/placement.md). Defaults to false.
`idSuffix`	`string`	No	Appended to the bundle id and applicationId, so environments install side by side.

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