config.Environment — Kuito Documentation

Utilisation

Fail builds on a fallback

Ce type est utilisé par config.KuitoConfig

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;

Déclaration du type

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

Membres 19

Nom	Type	Requis	Description
`name`	`string`	Non	Shown under the app icon.
`version`	`string`	Non	What users see: up to three numbers, like 1.2.0. Defaults to 1.0.0.
`buildNumber`	`number`	Non	What the stores order builds by; raise it for every upload. Defaults to 1.
`icon`	`string`	Non	A square PNG of at least 1024×1024, relative to kuito.config.ts.
`orientation`	`Orientation`	Non	The orientations the app runs in. `default` follows the device.
`colorScheme`	`ColorScheme`	Non	`light` or `dark` ignores the system setting, as CSS's `color-scheme`.
`backgroundColor`	`string`	Non	The root window's color, behind the app, like `#1E88E5`.
`statusBar`	`Overrides<{ style?: StatusBarStyle; hidden?: boolean;}>`	Non	The status bar at launch; `SystemBars` changes it at run time.
`urlSchemes`	`string[]`	Non	Schemes that open the app, like `myapp` for `myapp://show/42` (docs/linking.md).
`linkDomains`	`string[]`	Non	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;}>`	Non	—
`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>;}>`	Non	—
`permissions`	`Overrides<KuitoPermissions>`	Non	The permissions the app asks for (docs/permissions.md); none when absent.
`backgroundTasks`	`string[]`	Non	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)[]`	Non	.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>`	Non	The launch screen, and the view the app hands off from (docs/splash.md).
`updates`	`Overrides<{ url: string; publicKey: string;}>`	Non	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`	Non	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`	Non	Appended to the bundle id and applicationId, so environments install side by side.

Généré depuis les déclarations TypeScript publiques : signatures, props et valeurs par défaut viennent de la source vérifiée, les descriptions de sa JSDoc. Aucune valeur par défaut n'est inventée.