NativeScriptConfig

Defined in: config/config.interface.ts

IMPORTANT: this is not generated automatically due to this issue: https://github.com/microsoft/TypeScript/issues/36763 the reference path above will get rewritten and break on compilation unless kept here Once issue is resolve we can remove this index.d.ts from repo and go back to auto generation on tsc

Properties ​

android? ​

optional android?: IConfigAndroid;

Defined in: config/config.interface.ts

Android specific configurations Various Android specific configurations including Android runtime flags.

appPath? ​

optional appPath?: string;

Defined in: config/config.interface.ts

Path to the app source directory This is often the src or app directory however can be changed.

appResourcesPath? ​

optional appResourcesPath?: string;

Defined in: config/config.interface.ts

App_Resources path This is often at the root or inside src or app directory however can be anywhere.

bundler? ​

optional bundler?: BundlerType;

Defined in: config/config.interface.ts

Bundler to use for this project. Default is 'webpack'.

bundlerConfigPath? ​

optional bundlerConfigPath?: string;

Defined in: config/config.interface.ts

Custom bundler config path For example, vite.config.ts, webpack.config.js, etc. The default is webpack.config.js however you can use a custom name and place elsewhere.

cli? ​

optional cli?: IConfigCLI;

Defined in: config/config.interface.ts

Set cli options

cssParser? ​

optional cssParser?: "rework" | "nativescript" | "css-tree";

Defined in: config/config.interface.ts

Set the default CSS parser that NativeScript will use. Default: css-tree

discardUncaughtJsExceptions? ​

optional discardUncaughtJsExceptions?: boolean;

Defined in: config/config.interface.ts

Deprecated ​

Since runtime 9.1 uncaught JS errors no longer crash the app by default, so this flag is no longer needed. Remove it, or use uncaughtErrorPolicy.

Still honored while deprecated, with a one-time runtime warning: true routes uncaught errors to Application.discardedErrorEvent (instead of uncaughtErrorEvent), skips the fatal log and suppresses uncaughtErrorPolicy: 'throw'. false is ignored - it does NOT restore the old crash-on-uncaught behavior; set uncaughtErrorPolicy: 'throw' for that.

embed? ​

optional embed?: IConfigEmbed;

Defined in: config/config.interface.ts

For embedding into existing platform host projects.

hooks? ​

optional hooks?: IConfigHook[];

Defined in: config/config.interface.ts

Set project persistent hooks to run

id? ​

optional id?: string;

Defined in: config/config.interface.ts

App's bundle id Used for both iOS and Android if they use the same bundle id. You can override per platform in the respective platform specific configurations.

ignoredNativeDependencies? ​

optional ignoredNativeDependencies?: string[];

Defined in: config/config.interface.ts

Optionally specify a list of npm package names for which you would like the NativeScript CLI to ignore when attaching native dependencies to the build

ios? ​

optional ios?: IConfigIOS;

Defined in: config/config.interface.ts

iOS specific configurations Various iOS specific configurations including iOS runtime flags.

logScriptLoading? ​

optional logScriptLoading?: boolean;

Defined in: config/config.interface.ts

Enable runtime logging of script loading.

main? ​

optional main?: string;

Defined in: config/config.interface.ts

App's main entry file - this setting overrides the value set in package.json

overridePods? ​

optional overridePods?: string;

Defined in: config/config.interface.ts

previewAppSchema? ​

optional previewAppSchema?: string;

Defined in: config/config.interface.ts

profiling? ​

optional profiling?: InstrumentationMode;

Defined in: config/config.interface.ts

Enable profiling for the application. Default: no profiling In most cases when profiling, you will want to use "timeline"

projectName? ​

optional projectName?: string;

Defined in: config/config.interface.ts

Custom platform project name. By default, the platforms/{platform}/{name} is based on the basename of the project directory. You can override that to use a name of your choice by setting this.

security? ​

optional security?: ISecurityConfig;

Defined in: config/config.interface.ts

Security configurations

shared? ​

optional shared?: boolean;

Defined in: config/config.interface.ts

showErrorDisplay? ​

optional showErrorDisplay?: boolean;

Defined in: config/config.interface.ts

Show visual error display when an uncaught JS exception occurs.

uncaughtErrorPolicy? ​

optional uncaughtErrorPolicy?: UncaughtErrorPolicy;

Defined in: config/config.interface.ts

Policy for uncaught JS errors and unhandled promise rejections that no listener handled. Default: 'report' - the app keeps running.

Requires runtime 9.1+ (iOS and Android); older runtimes ignore the key and crash on uncaught errors as before. Read only from the top level of the config - a value nested under ios / android has no effect.

To handle individual errors instead, add a globalThis listener and cancel the event: globalThis.addEventListener('unhandledrejection', (e) => e.preventDefault()).

visionos? ​

optional visionos?: IConfigVisionOS;

Defined in: config/config.interface.ts

Vision Pro specific configurations Various VisionOS specific configurations including iOS runtime flags.

webpackConfigPath? ​

optional webpackConfigPath?: string;

Defined in: config/config.interface.ts

Deprecated ​

Use bundlerConfigPath instead. Custom webpack config path The default is webpack.config.js in the root however you can use a custom name and place elsewhere.