config.Environment — Kuito Dokumentation

Verwendung

Fail builds on a fallback

Dieser Typ wird verwendet von 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;

Typdeklaration

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

Mitglieder 19

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

Generiert aus den öffentlichen TypeScript-Deklarationen: Signaturen, Props und Standardwerte stammen aus der geprüften Quelle, Beschreibungen aus deren JSDoc. Kein Standardwert ist erfunden.