Preview 2.0 is now in Public Beta!
Read the Announcement
Note: You are on the beta version of our docs. This is a work in progress and may contain broken links and pages.
NativeScriptConfig
interface NativeScriptConfig {
  android: IConfigAndroid;
  appPath: string;
  appResourcesPath: string;
  cli: IConfigCLI;
  cssParser: "rework" | "nativescript" | "css-tree";
  hooks: IConfigHook[];
  id: string;
  ignoredNativeDependencies: string[];
  ios: IConfigIOS;
  main: string;
  overridePods: string;
  previewAppSchema: string;
  profiling: InstrumentationMode;
  shared: boolean;
  webpackConfigPath: string;
}

Summary ​

Properties ​

android ​

android?: IConfigAndroid
Android specific configurations Various Android specific configurations including Android runtime flags.

appPath ​

appPath?: string
Path to the app source directory This is often the `src` or `app` directory however can be changed.

appResourcesPath ​

appResourcesPath?: string
App_Resources path This is often at the root or inside `src` or `app` directory however can be anywhere.

cli ​

cli?: IConfigCLI
Set cli options

cssParser ​

cssParser?: "rework" | "nativescript" | "css-tree"
Set the default CSS parser that NativeScript will use. Default: css-tree

hooks ​

hooks?: IConfigHook[]
Set project persistent hooks to run

id ​

id?: string
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 ​

ignoredNativeDependencies?: string[]
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 ​

ios?: IConfigIOS
iOS specific configurations Various iOS specific configurations including iOS runtime flags.

main ​

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

overridePods ​

overridePods?: string

previewAppSchema ​

previewAppSchema?: string

profiling ​

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

shared ​

shared?: boolean

webpackConfigPath ​

webpackConfigPath?: string
Custom webpack config path The default is `webpack.config.js` in the root however you can use a custom name and place elsewhere.
Previous
LoginResult
Next
NativeScriptError