@rnv/core

Type Aliases

AsyncCallback

Ƭ AsyncCallback: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/projects/types.d.ts:3

---

BuildConfigKey

Ƭ BuildConfigKey: keyof ConfigFileBuildConfig

Defined in

@rnv/core/lib/schema/types.d.ts:89

---

CommonBuildSchemeKey

Ƭ CommonBuildSchemeKey: keyof ConfigCommonBuildSchemeSchema

Defined in

@rnv/core/lib/schema/types.d.ts:42

---

CommonPropKey

Ƭ CommonPropKey: keyof ConfigCommonSchemaFragment

Defined in

@rnv/core/lib/schema/types.d.ts:40

---

ConfigAndroidManifest

Ƭ ConfigAndroidManifest: Object

Type declaration

Name	Type
children?	ConfigAndroidManifestChildType[]
package?	string
tag	string
xmlns:android?	string
xmlns:tools?	string

Defined in

@rnv/core/lib/schema/types.d.ts:57

---

ConfigAndroidManifestChildType

Ƭ ConfigAndroidManifestChildType: z.infer<typeof zodManifestChildBase> & { children?: ConfigAndroidManifestChildType[] }

Defined in

@rnv/core/lib/schema/types.d.ts:54

---

ConfigAndroidManifestNode

Ƭ ConfigAndroidManifestNode: ConfigAndroidManifestChildType

Defined in

@rnv/core/lib/schema/types.d.ts:53

---

ConfigAndroidResources

Ƭ ConfigAndroidResources: Object

Type declaration

Name	Type
children?	ConfigAndroidResourcesChildType[]
name?	string
parent?	string
tag	string
value?	string

Defined in

@rnv/core/lib/schema/types.d.ts:59

---

ConfigAndroidResourcesChildType

Ƭ ConfigAndroidResourcesChildType: z.infer<typeof zodResourcesChildBase> & { children?: ConfigAndroidResourcesChildType[] }

Defined in

@rnv/core/lib/schema/types.d.ts:61

---

ConfigAndroidResourcesNode

Ƭ ConfigAndroidResourcesNode: ConfigAndroidResourcesChildType

Defined in

@rnv/core/lib/schema/types.d.ts:60

---

ConfigAppDelegateMethod

Ƭ ConfigAppDelegateMethod: ConfigTemplateXcodeAppDelegateMethod[number]

Defined in

@rnv/core/lib/schema/types.d.ts:65

---

ConfigBuildSchemeFragment

Ƭ ConfigBuildSchemeFragment: Object

Type declaration

Name	Type
description?	string
enabled?	boolean

Defined in

@rnv/core/lib/schema/types.d.ts:37

---

ConfigCommonBuildSchemeSchema

Ƭ ConfigCommonBuildSchemeSchema: Partial<ConfigCommonSchemaFragment & ConfigBuildSchemeFragment & ConfigPlatformBaseFragment>

Defined in

@rnv/core/lib/schema/types.d.ts:41

---

ConfigCommonSchema

Ƭ ConfigCommonSchema: Partial<ConfigCommonSchemaFragment> & { buildSchemes?: Record<string, ConfigCommonBuildSchemeSchema> }

Defined in

@rnv/core/lib/schema/types.d.ts:43

---

ConfigCommonSchemaFragment

Ƭ ConfigCommonSchemaFragment: Object

Type declaration

Name	Type
assetSources?	string[]
author?	string
backgroundColor?	string
custom?	any
description?	string
excludedPermissions?	string[]
excludedPlugins?	string[]
fontSources?	string[]
id?	string
idSuffix?	string
includedFonts?	string[]
includedPermissions?	string[]
includedPlugins?	string[]
license?	string
runtime?	any
splashScreen?	boolean
title?	string
version?	string
versionCode?	string
versionCodeFormat?	string
versionCodeOffset?	number
versionFormat?	string

Defined in

@rnv/core/lib/schema/types.d.ts:39

---

ConfigFileApp

Ƭ ConfigFileApp: ConfigRootAppBaseFragment & { common?: ConfigCommonSchema ; platforms?: ConfigPlatformsSchema ; plugins?: ConfigPluginsSchema }

Defined in

@rnv/core/lib/schema/types.d.ts:80

---

ConfigFileBuildConfig

Ƭ ConfigFileBuildConfig: ConfigFileTemplates & ConfigFileWorkspace & RootPluginsMerged & ConfigFileProject & ConfigFileLocal & ConfigRootAppBaseFragment

Defined in

@rnv/core/lib/schema/types.d.ts:88

---

ConfigFileEngine

Ƭ ConfigFileEngine: Object

Type declaration

Name	Type
custom?	any
engineExtension?	string
id?	string
npm?	{ dependencies?: Record<string, string> ; devDependencies?: Record<string, string> ; optionalDependencies?: Record<string, string> ; peerDependencies?: Record<string, string> }
npm.dependencies?	Record<string, string>
npm.devDependencies?	Record<string, string>
npm.optionalDependencies?	Record<string, string>
npm.peerDependencies?	Record<string, string>
overview?	string
packageName?	string
platforms?	Partial<Record<"android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox", { engine?: string ; npm?: { dependencies?: Record<string, string> ; devDependencies?: Record<string, string> ; optionalDependencies?: Record<string, string> ; peerDependencies?: Record<string, string> } }>>
plugins?	Record<string, string>

Defined in

@rnv/core/lib/schema/types.d.ts:93

---

ConfigFileIntegration

Ƭ ConfigFileIntegration: Object

Type declaration

Name	Type
packageName?	string

Defined in

@rnv/core/lib/schema/types.d.ts:94

---

ConfigFileLocal

Ƭ ConfigFileLocal: Object

Type declaration

Name	Type
_meta?	{ currentAppConfigId?: string ; requiresJetify?: boolean }
_meta.currentAppConfigId?	string
_meta.requiresJetify?	boolean
defaultTargets?	Partial<Record<"android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox", string>>
workspaceAppConfigsDir?	string

Defined in

@rnv/core/lib/schema/types.d.ts:95

---

ConfigFileOverrides

Ƭ ConfigFileOverrides: Object

Type declaration

Name	Type
overrides?	Record<string, Record<string, string>>

Defined in

@rnv/core/lib/schema/types.d.ts:96

---

ConfigFilePlugin

Ƭ ConfigFilePlugin: ConfigPluginSchema & z.infer<typeof zodPluginFragment>

Defined in

@rnv/core/lib/schema/types.d.ts:105

---

ConfigFilePrivate

Ƭ ConfigFilePrivate: Object

Type declaration

Name	Type
platforms?	{ android?: { keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string } ; androidtv?: { keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string } ; androidwear?: { keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string } ; chromecast?: any ; firetv?: { keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string } ; ios?: any ; kaios?: any ; linux?: any ; macos?: any ; tizen?: any ; tizenmobile?: any ; tizenwatch?: any ; tvos?: any ; web?: any ; webos?: any ; webtv?: any ; windows?: any ; xbox?: any }
platforms.android?	{ keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string }
platforms.android.keyAlias?	string
platforms.android.keyPassword?	string
platforms.android.storeFile?	string
platforms.android.storePassword?	string
platforms.androidtv?	{ keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string }
platforms.androidtv.keyAlias?	string
platforms.androidtv.keyPassword?	string
platforms.androidtv.storeFile?	string
platforms.androidtv.storePassword?	string
platforms.androidwear?	{ keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string }
platforms.androidwear.keyAlias?	string
platforms.androidwear.keyPassword?	string
platforms.androidwear.storeFile?	string
platforms.androidwear.storePassword?	string
platforms.chromecast?	any
platforms.firetv?	{ keyAlias?: string ; keyPassword?: string ; storeFile?: string ; storePassword?: string }
platforms.firetv.keyAlias?	string
platforms.firetv.keyPassword?	string
platforms.firetv.storeFile?	string
platforms.firetv.storePassword?	string
platforms.ios?	any
platforms.kaios?	any
platforms.linux?	any
platforms.macos?	any
platforms.tizen?	any
platforms.tizenmobile?	any
platforms.tizenwatch?	any
platforms.tvos?	any
platforms.web?	any
platforms.webos?	any
platforms.webtv?	any
platforms.windows?	any
platforms.xbox?	any
private?	Record<string, any>

Defined in

@rnv/core/lib/schema/types.d.ts:107

---

ConfigFileProject

Ƭ ConfigFileProject: ConfigRootProjectBaseFragment & { common?: ConfigCommonSchema ; platforms?: ConfigPlatformsSchema ; plugins?: ConfigPluginsSchema }

Defined in

@rnv/core/lib/schema/types.d.ts:112

---

ConfigFileRenative

Ƭ ConfigFileRenative: Object

Type declaration

Name	Type
app	ConfigFileApp
engine	ConfigFileEngine
integration	ConfigFileIntegration
local	ConfigFileLocal
overrides	ConfigFileOverrides
plugin	ConfigFilePlugin
private	ConfigFilePrivate
project	ConfigFileProject
templateIntegrations	ConfigFileTemplates
templatePlugins	ConfigFileTemplates
templateProject	ConfigFileTemplate
templateProjects	ConfigFileTemplates
workspace	ConfigFileWorkspace
workspaces	ConfigFileWorkspaces

Defined in

@rnv/core/lib/schema/types.d.ts:125

---

ConfigFileRuntime

Ƭ ConfigFileRuntime: Object

Defined in

@rnv/core/lib/schema/types.d.ts:141

---

ConfigFileTemplate

Ƭ ConfigFileTemplate: Object

Type declaration

Name	Type
bootstrapConfig?	ConfigTemplateBootstrapConfig
templateConfig?	ConfigTemplateConfigFragment

Defined in

@rnv/core/lib/schema/types.d.ts:118

---

ConfigFileTemplates

Ƭ ConfigFileTemplates: Object

Defined in

@rnv/core/lib/schema/types.d.ts:122

---

ConfigFileWorkspace

Ƭ ConfigFileWorkspace: Object

Type declaration

Name	Type
appConfigsPath?	string
defaultTargets?	Partial<Record<"android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox", string>>
disableTelemetry?	boolean
projectTemplates?	Record<string, { description?: string ; localPath?: string ; packageName?: string }>
sdks?	{ ANDROID_NDK?: string ; ANDROID_SDK?: string ; KAIOS_SDK?: string ; TIZEN_SDK?: string ; WEBOS_SDK?: string }
sdks.ANDROID_NDK?	string
sdks.ANDROID_SDK?	string
sdks.KAIOS_SDK?	string
sdks.TIZEN_SDK?	string
sdks.WEBOS_SDK?	string

Defined in

@rnv/core/lib/schema/types.d.ts:123

---

ConfigFileWorkspaces

Ƭ ConfigFileWorkspaces: Object

Type declaration

Name	Type
workspaces	Record<string, { path: string ; remote?: { type: string ; url: string } }>

Defined in

@rnv/core/lib/schema/types.d.ts:124

---

ConfigPlatformAndroidFragment

Ƭ ConfigPlatformAndroidFragment: Object

Type declaration

Name	Type
aab?	boolean
buildToolsVersion?	string
compileSdkVersion?	number
disableSigning?	boolean
enableAndroidX?	string | boolean
enableJetifier?	string | boolean
excludedFeatures?	string[]
extraGradleParams?	string
flipperEnabled?	boolean
googleServicesVersion?	string
gradleBuildToolsVersion?	string
gradleWrapperVersion?	string
includedFeatures?	string[]
keyAlias?	string
kotlinVersion?	string
minSdkVersion?	number
minifyEnabled?	boolean
multipleAPKs?	boolean
ndkVersion?	string
newArchEnabled?	boolean
signingConfig?	string
storeFile?	string
supportLibVersion?	string
targetSdkVersion?	number

Defined in

@rnv/core/lib/schema/types.d.ts:46

---

ConfigPlatformBaseFragment

Ƭ ConfigPlatformBaseFragment: Object

Type declaration

Name	Type
assetFolderPlatform?	string
bundleAssets?	boolean
bundleIsDev?	boolean
enableSourceMaps?	boolean
engine?	string
entryFile?	string
extendPlatform?	"android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox"
getJsBundleFile?	string

Defined in

@rnv/core/lib/schema/types.d.ts:47

---

ConfigPlatformBuildSchemeSchema

Ƭ ConfigPlatformBuildSchemeSchema: ConfigCommonSchemaFragment & ConfigBuildSchemeFragment & ConfigPlatformSchemaFragment

Defined in

@rnv/core/lib/schema/types.d.ts:73

---

ConfigPlatformElectronFragment

Ƭ ConfigPlatformElectronFragment: Object

Type declaration

Name	Type
BrowserWindow?	{ height?: number ; webPreferences?: { devTools: boolean } ; width?: number }
BrowserWindow.height?	number
BrowserWindow.webPreferences?	{ devTools: boolean }
BrowserWindow.webPreferences.devTools	boolean
BrowserWindow.width?	number
electronConfig?	any

Defined in

@rnv/core/lib/schema/types.d.ts:48

---

ConfigPlatformLightningFragment

Ƭ ConfigPlatformLightningFragment: Object

Type declaration

Name	Type
target?	string

Defined in

@rnv/core/lib/schema/types.d.ts:50

---

ConfigPlatformNextJsFragment

Ƭ ConfigPlatformNextJsFragment: Object

Type declaration

Name	Type
exportDir?	string
nextTranspileModules?	string[]
outputDir?	string
pagesDir?	string

Defined in

@rnv/core/lib/schema/types.d.ts:51

---

ConfigPlatformReactNativeFragment

Ƭ ConfigPlatformReactNativeFragment: Object

Type declaration

Name	Type
reactNativeEngine?	"jsc" | "v8-android" | "v8-android-nointl" | "v8-android-jit" | "v8-android-jit-nointl" | "hermes"

Defined in

@rnv/core/lib/schema/types.d.ts:52

---

ConfigPlatformSchema

Ƭ ConfigPlatformSchema: ConfigPlatformSchemaFragment & { buildSchemes?: Record<string, ConfigPlatformBuildSchemeSchema> }

Defined in

@rnv/core/lib/schema/types.d.ts:75

---

ConfigPlatformSchemaFragment

Ƭ ConfigPlatformSchemaFragment: ConfigCommonSchemaFragment & ConfigPlatformBaseFragment & ConfigPlatformiOSFragment & ConfigPlatformAndroidFragment & ConfigPrivatePlatformAndroid & ConfigPlatformWebFragment & ConfigPlatformTizenFragment & ConfigPlatformWindowsFragment & ConfigPlatformWebOSFragment & ConfigPlatformLightningFragment & ConfigPlatformReactNativeFragment & ConfigPlatformWebpackFragment & ConfigPlatformElectronFragment & ConfigPlatformNextJsFragment & ConfigTemplateAndroidFragment & ConfigTemplateXcodeFragment

Defined in

@rnv/core/lib/schema/types.d.ts:71

---

ConfigPlatformTizenFragment

Ƭ ConfigPlatformTizenFragment: Object

Type declaration

Name	Type
appName?	string
certificateProfile?	string
package?	string

Defined in

@rnv/core/lib/schema/types.d.ts:66

---

ConfigPlatformWebFragment

Ƭ ConfigPlatformWebFragment: Object

Type declaration

Name	Type
devServerHost?	string
environment?	string
timestampBuildFiles?	string[]

Defined in

@rnv/core/lib/schema/types.d.ts:67

---

ConfigPlatformWebOSFragment

Ƭ ConfigPlatformWebOSFragment: Object

Type declaration

Name	Type
iconColor?	string

Defined in

@rnv/core/lib/schema/types.d.ts:68

---

ConfigPlatformWebpackFragment

Ƭ ConfigPlatformWebpackFragment: Object

Type declaration

Name	Type
webpackConfig?	{ customScripts?: string[] ; publicUrl?: string }
webpackConfig.customScripts?	string[]
webpackConfig.publicUrl?	string

Defined in

@rnv/core/lib/schema/types.d.ts:69

---

ConfigPlatformWindowsFragment

Ƭ ConfigPlatformWindowsFragment: Object

Type declaration

Name	Type
templateVSProject?	{ additionalMetroOptions?: Record<string, any> ; appPath?: string ; arch?: string ; autolink?: boolean ; build?: boolean ; buildLogDirectory?: string ; bundle?: boolean ; devPort?: string ; device?: boolean ; directDebugging?: boolean ; emulator?: boolean ; experimentalNuGetDependency?: boolean ; info?: boolean ; language?: string ; launch?: boolean ; logging?: boolean ; msbuildprops?: string ; nuGetTestFeed?: string ; nuGetTestVersion?: string ; overwrite?: boolean ; packageExtension?: string ; packager?: boolean ; proj?: string ; reactNativeEngine?: string ; release?: boolean ; remoteDebugging?: boolean ; root?: string ; singleproc?: boolean ; sln?: string ; target?: string ; telemetry?: boolean ; useWinUI3?: boolean }
templateVSProject.additionalMetroOptions?	Record<string, any>
templateVSProject.appPath?	string
templateVSProject.arch?	string
templateVSProject.autolink?	boolean
templateVSProject.build?	boolean
templateVSProject.buildLogDirectory?	string
templateVSProject.bundle?	boolean
templateVSProject.devPort?	string
templateVSProject.device?	boolean
templateVSProject.directDebugging?	boolean
templateVSProject.emulator?	boolean
templateVSProject.experimentalNuGetDependency?	boolean
templateVSProject.info?	boolean
templateVSProject.language?	string
templateVSProject.launch?	boolean
templateVSProject.logging?	boolean
templateVSProject.msbuildprops?	string
templateVSProject.nuGetTestFeed?	string
templateVSProject.nuGetTestVersion?	string
templateVSProject.overwrite?	boolean
templateVSProject.packageExtension?	string
templateVSProject.packager?	boolean
templateVSProject.proj?	string
templateVSProject.reactNativeEngine?	string
templateVSProject.release?	boolean
templateVSProject.remoteDebugging?	boolean
templateVSProject.root?	string
templateVSProject.singleproc?	boolean
templateVSProject.sln?	string
templateVSProject.target?	string
templateVSProject.telemetry?	boolean
templateVSProject.useWinUI3?	boolean

Defined in

@rnv/core/lib/schema/types.d.ts:70

---

ConfigPlatformiOSFragment

Ƭ ConfigPlatformiOSFragment: Object

Type declaration

Name	Type
allowProvisioningUpdates?	boolean
appleId?	string
codeSignIdentities?	Record<string, string>
codeSignIdentity?	string
commandLineArguments?	string[]
deploymentTarget?	string
entitlements?	Record<string, string>
excludedArchs?	string[]
exportOptions?	{ compileBitcode?: boolean ; method?: string ; provisioningProfiles?: Record<string, string> ; signingCertificate?: string ; signingStyle?: string ; teamID?: string ; uploadBitcode?: boolean ; uploadSymbols?: boolean }
exportOptions.compileBitcode?	boolean
exportOptions.method?	string
exportOptions.provisioningProfiles?	Record<string, string>
exportOptions.signingCertificate?	string
exportOptions.signingStyle?	string
exportOptions.teamID?	string
exportOptions.uploadBitcode?	boolean
exportOptions.uploadSymbols?	boolean
firebaseId?	string
ignoreLogs?	boolean
ignoreWarnings?	boolean
newArchEnabled?	boolean
orientationSupport?	{ phone?: string[] ; tab?: string[] }
orientationSupport.phone?	string[]
orientationSupport.tab?	string[]
provisionProfileSpecifier?	string
provisionProfileSpecifiers?	Record<string, string>
provisioningProfiles?	Record<string, string>
provisioningStyle?	string
runScheme?	string
scheme?	string
schemeTarget?	string
sdk?	string
systemCapabilities?	Record<string, boolean>
teamID?	string
teamIdentifier?	string
testFlightId?	string
urlScheme?	string

Defined in

@rnv/core/lib/schema/types.d.ts:49

---

ConfigPlatformsSchema

Ƭ ConfigPlatformsSchema: Partial<Record<RnvPlatformKey, ConfigPlatformSchema>>

Defined in

@rnv/core/lib/schema/types.d.ts:78

---

ConfigPluginBaseFragment

Ƭ ConfigPluginBaseFragment: Object

Type declaration

Name	Type
deprecated?	string
disableNpm?	boolean
disablePluginTemplateOverrides?	boolean
disabled?	boolean
fontSources?	string[]
npm?	Record<string, string>
pluginDependencies?	Record<string, string>
props?	Record<string, string>
skipMerge?	boolean
source?	string
supportedPlatforms?	("android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox")[]
version?	string
webpackConfig?	{ moduleAliases?: boolean | Record<string, string | { projectPath: string }> ; modulePaths?: boolean | string[] ; nextTranspileModules?: string[] }
webpackConfig.moduleAliases?	boolean | Record<string, string | { projectPath: string }>
webpackConfig.modulePaths?	boolean | string[]
webpackConfig.nextTranspileModules?	string[]

Defined in

@rnv/core/lib/schema/types.d.ts:97

---

ConfigPluginPlatformAndroidFragment

Ƭ ConfigPluginPlatformAndroidFragment: Partial<z.infer<typeof zodPluginPlatformAndroidFragment>>

Defined in

@rnv/core/lib/schema/types.d.ts:98

---

ConfigPluginPlatformBaseFragment

Ƭ ConfigPluginPlatformBaseFragment: Partial<z.infer<typeof zodPluginPlatformBaseFragment>>

Defined in

@rnv/core/lib/schema/types.d.ts:99

---

ConfigPluginPlatformSchema

Ƭ ConfigPluginPlatformSchema: ConfigPluginPlatformBaseFragment & ConfigPluginPlatformAndroidFragment & ConfigPluginPlatformiOSFragment

Defined in

@rnv/core/lib/schema/types.d.ts:101

---

ConfigPluginPlatformiOSFragment

Ƭ ConfigPluginPlatformiOSFragment: Partial<z.infer<typeof zodPluginPlatformiOSFragment>>

Defined in

@rnv/core/lib/schema/types.d.ts:100

---

ConfigPluginPlatformsSchema

Ƭ ConfigPluginPlatformsSchema: Record<RnvPlatformKey, ConfigPluginPlatformSchema>

Defined in

@rnv/core/lib/schema/types.d.ts:102

---

ConfigPluginSchema

Ƭ ConfigPluginSchema: ConfigPluginBaseFragment & Partial<ConfigPluginPlatformsSchema>

Defined in

@rnv/core/lib/schema/types.d.ts:103

---

ConfigPluginsSchema

Ƭ ConfigPluginsSchema: Record<string, ConfigPluginSchema | string>

Defined in

@rnv/core/lib/schema/types.d.ts:104

---

ConfigPrivatePlatformAndroid

Ƭ ConfigPrivatePlatformAndroid: Object

Type declaration

Name	Type
keyAlias?	string
keyPassword?	string
storeFile?	string
storePassword?	string

Defined in

@rnv/core/lib/schema/types.d.ts:106

---

ConfigProjectPaths

Ƭ ConfigProjectPaths: Required<ConfigRootProjectBaseFragment>["paths"]

Defined in

@rnv/core/lib/schema/types.d.ts:111

---

ConfigProp

Ƭ ConfigProp: ConfigPlatformSchemaFragment

Defined in

@rnv/core/lib/schema/types.d.ts:142

---

ConfigPropKey

Ƭ ConfigPropKey: keyof ConfigProp

Defined in

@rnv/core/lib/schema/types.d.ts:143

---

ConfigPropKeyMerged

Ƭ ConfigPropKeyMerged<T>: keyof ConfigPropMerged<T>

Type parameters

Name
T

Defined in

@rnv/core/lib/schema/types.d.ts:145

---

ConfigPropMerged

Ƭ ConfigPropMerged<T>: ConfigProp & T

Type parameters

Name
T

Defined in

@rnv/core/lib/schema/types.d.ts:144

---

ConfigPropRootKeyMerged

Ƭ ConfigPropRootKeyMerged<T>: keyof ConfigPropRootMerged<T>

Type parameters

Name
T

Defined in

@rnv/core/lib/schema/types.d.ts:91

---

ConfigPropRootMerged

Ƭ ConfigPropRootMerged<T>: ConfigFileBuildConfig & T

Type parameters

Name
T

Defined in

@rnv/core/lib/schema/types.d.ts:90

---

ConfigRootAppBaseFragment

Ƭ ConfigRootAppBaseFragment: Object

Type declaration

Name	Type
custom?	any
extend?	string
extendsTemplate?	string
hidden?	boolean
id?	string

Defined in

@rnv/core/lib/schema/types.d.ts:79

---

ConfigRootProjectBaseFragment

Ƭ ConfigRootProjectBaseFragment: z.infer<typeof zodRootProjectBaseFragment> & { templateConfig?: ConfigTemplateConfigFragment }

Defined in

@rnv/core/lib/schema/types.d.ts:108

---

ConfigTemplateAndroidFragment

Ƭ ConfigTemplateAndroidFragment: Object

Type declaration

Name	Type
templateAndroid?	ConfigTemplateAndroidBase

Defined in

@rnv/core/lib/schema/types.d.ts:58

---

ConfigTemplateConfigFragment

Ƭ ConfigTemplateConfigFragment: Object

Type declaration

Name	Type
disabled?	boolean
includedPaths?	(string | { engines?: string[] ; paths: string[] ; platforms?: ("android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox")[] })[]
name?	string
package_json?	{ browserslist?: any ; dependencies?: Record<string, string> ; devDependencies?: Record<string, string> ; name?: string ; optionalDependencies?: Record<string, string> ; peerDependencies?: Record<string, string> ; version?: string }
package_json.browserslist?	any
package_json.dependencies?	Record<string, string>
package_json.devDependencies?	Record<string, string>
package_json.name?	string
package_json.optionalDependencies?	Record<string, string>
package_json.peerDependencies?	Record<string, string>
package_json.version?	string
renative_json?	{ $schema?: string ; extendsTemplate?: string }
renative_json.$schema?	string
renative_json.extendsTemplate?	string
version?	string

Defined in

@rnv/core/lib/schema/types.d.ts:38

---

ConfigTemplateXcodeFragment

Ƭ ConfigTemplateXcodeFragment: Object

Type declaration

Name	Type
templateXcode?	{ AppDelegate_h?: { appDelegateExtensions?: string[] ; appDelegateImports?: string[] } ; AppDelegate_mm?: { appDelegateImports?: string[] ; appDelegateMethods?: { application?: ConfigTemplateXcodeApplication ; userNotificationCenter?: { didReceiveNotificationResponse?: (string | { order: number ; value: string ; weight: number })[] ; willPresent?: (string | { order: number ; value: string ; weight: number })[] } } } ; Info_plist?: Record<string, string> ; Podfile?: { header?: string[] ; injectLines?: string[] ; podDependencies?: string[] ; post_install?: string[] ; sources?: string[] ; staticPods?: string[] } ; project_pbxproj?: ConfigTemplateXcodeProjectPbxproj }
templateXcode.AppDelegate_h?	{ appDelegateExtensions?: string[] ; appDelegateImports?: string[] }
templateXcode.AppDelegate_h.appDelegateExtensions?	string[]
templateXcode.AppDelegate_h.appDelegateImports?	string[]
templateXcode.AppDelegate_mm?	{ appDelegateImports?: string[] ; appDelegateMethods?: { application?: ConfigTemplateXcodeApplication ; userNotificationCenter?: { didReceiveNotificationResponse?: (string | { order: number ; value: string ; weight: number })[] ; willPresent?: (string | { order: number ; value: string ; weight: number })[] } } }
templateXcode.AppDelegate_mm.appDelegateImports?	string[]
templateXcode.AppDelegate_mm.appDelegateMethods?	{ application?: ConfigTemplateXcodeApplication ; userNotificationCenter?: { didReceiveNotificationResponse?: (string | { order: number ; value: string ; weight: number })[] ; willPresent?: (string | { order: number ; value: string ; weight: number })[] } }
templateXcode.AppDelegate_mm.appDelegateMethods.application?	ConfigTemplateXcodeApplication
templateXcode.AppDelegate_mm.appDelegateMethods.userNotificationCenter?	{ didReceiveNotificationResponse?: (string | { order: number ; value: string ; weight: number })[] ; willPresent?: (string | { order: number ; value: string ; weight: number })[] }
templateXcode.AppDelegate_mm.appDelegateMethods.userNotificationCenter.didReceiveNotificationResponse?	(string | { order: number ; value: string ; weight: number })[]
templateXcode.AppDelegate_mm.appDelegateMethods.userNotificationCenter.willPresent?	(string | { order: number ; value: string ; weight: number })[]
templateXcode.Info_plist?	Record<string, string>
templateXcode.Podfile?	{ header?: string[] ; injectLines?: string[] ; podDependencies?: string[] ; post_install?: string[] ; sources?: string[] ; staticPods?: string[] }
templateXcode.Podfile.header?	string[]
templateXcode.Podfile.injectLines?	string[]
templateXcode.Podfile.podDependencies?	string[]
templateXcode.Podfile.post_install?	string[]
templateXcode.Podfile.sources?	string[]
templateXcode.Podfile.staticPods?	string[]
templateXcode.project_pbxproj?	ConfigTemplateXcodeProjectPbxproj

Defined in

@rnv/core/lib/schema/types.d.ts:64

---

CreateContextOptions

Ƭ CreateContextOptions: Object

Type declaration

Name	Type
RNV_HOME_DIR?	string
cmd?	string
process	NodeJS.Process
program	RnvContextProgram
subCmd?	string

Defined in

@rnv/core/lib/context/types.d.ts:13

---

CreateRnvEngineOpts

Ƭ CreateRnvEngineOpts<OKey>: Object

Type parameters

Name	Type
OKey	extends string

Type declaration

Name	Type
config	ConfigFileEngine
originalTemplatePlatformProjectDir?	string
originalTemplatePlatformsDir?	string
outputDirName?	string
platforms	RnvEnginePlatforms
projectDirName?	string
rootPath?	string
runtimeExtraProps?	Record<string, string>
serverDirName?	string
tasks	ReadonlyArray<RnvTask<OKey>>

Defined in

@rnv/core/lib/engines/types.d.ts:6

---

CreateRnvIntegrationOpts

Ƭ CreateRnvIntegrationOpts<OKey>: Object

Type parameters

Name	Type
OKey	extends string

Type declaration

Name	Type
config	ConfigFileIntegration
tasks	ReadonlyArray<RnvTask<OKey>>

Defined in

@rnv/core/lib/integrations/types.d.ts:4

---

CreateRnvSdkOpts

Ƭ CreateRnvSdkOpts<OKey>: Object

Type parameters

Name	Type
OKey	extends string

Type declaration

Name	Type
tasks	ReadonlyArray<RnvTask<OKey>>

Defined in

@rnv/core/lib/sdks/types.d.ts:3

---

CreateRnvTaskOpt

Ƭ CreateRnvTaskOpt<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
beforeDependsOn?	RnvTaskFn
dependsOn?	string[]
description	string
fn?	RnvTaskFn<OKey>
fnHelp?	RnvTaskHelpFn
forceBuildHookRebuild?	boolean
ignoreEngines?	boolean
isGlobalScope?	boolean
isPriorityOrder?	boolean
isPrivate?	boolean
options?	ReadonlyArray<RnvTaskOption<OKey>>
platforms?	RnvPlatformKey[]
task	string

Defined in

@rnv/core/lib/tasks/types.d.ts:3

---

DependencyMutation

Ƭ DependencyMutation: Object

Type declaration

Name	Type
msg	string
name	string
original?	{ version: string }
original.version	string
source	string
targetPath?	string
type	NpmDepKey
updated	{ version: string }
updated.version	string

Defined in

@rnv/core/lib/projects/types.d.ts:4

---

DoResolveFn

Ƭ DoResolveFn: (aPath?: string, mandatory?: boolean, options?: ResolveOptions) => string | undefined

Type declaration

▸ (aPath?, mandatory?, options?): string | undefined

Parameters

Name	Type
aPath?	string
mandatory?	boolean
options?	ResolveOptions

Returns

string | undefined

Defined in

@rnv/core/lib/system/types.d.ts:1

---

Env

Ƭ Env: Record<string, any>

Defined in

@rnv/core/lib/types.d.ts:8

---

ExecCallback

Ƭ ExecCallback: (result: unknown, isError: boolean) => void

Type declaration

▸ (result, isError): void

Parameters

Name	Type
result	unknown
isError	boolean

Returns

void

Defined in

@rnv/core/lib/system/types.d.ts:27

---

ExecOptions

Ƭ ExecOptions: Object

Type declaration

Name	Type
all?	boolean
cwd?	string
detached?	boolean
env?	Record<string, any>
ignoreErrors?	boolean
localDir?	string
maxErrorLength?	number
mono?	boolean
preferLocal?	boolean
privateParams?	string[]
rawCommand?	{ args: string[] }
rawCommand.args	string[]
shell?	boolean
silent?	boolean
stdio?	"pipe" | "inherit" | "ignore"
timeout?	number

Defined in

@rnv/core/lib/system/types.d.ts:8

---

FileUtilsPropConfig

Ƭ FileUtilsPropConfig: Object

Type declaration

Name	Type
configProps?	Record<string, any>
files?	Record<string, any>
props	Record<string, string>
runtimeProps?	Record<string, any>

Defined in

@rnv/core/lib/system/types.d.ts:37

---

GetConfigPropFn

Ƭ GetConfigPropFn<T>: T extends ConfigPropKey ? <T>(key: T, defaultVal?: ConfigProp[T], obj?: Partial<ConfigFileBuildConfig>) => ConfigProp[T] | undefined : <T>(key: string, defaultVal?: T, obj?: Partial<ConfigFileBuildConfig>) => T | undefined

Type parameters

Name	Type
T	ConfigPropKey

Defined in

@rnv/core/lib/api/types.d.ts:119

---

GetConfigPropVal

Ƭ GetConfigPropVal<T, K>: ConfigPropMerged<T>[K] | undefined

Type parameters

Name	Type
T	T
K	extends ConfigPropKeyMerged<T>

Defined in

@rnv/core/lib/schema/types.d.ts:146

---

GetConfigRootPropVal

Ƭ GetConfigRootPropVal<T, K>: ConfigPropRootMerged<T>[K] | undefined

Type parameters

Name	Type
T	T
K	extends ConfigPropRootKeyMerged<T>

Defined in

@rnv/core/lib/schema/types.d.ts:92

---

GetContextType

Ƭ GetContextType<Type>: () => GetReturnType<Type>

Type parameters

Name
Type

Type declaration

▸ (): GetReturnType<Type>

Returns

GetReturnType<Type>

Defined in

@rnv/core/lib/context/types.d.ts:303

---

GetReturnType

Ƭ GetReturnType<Type>: Type extends (...args: never[]) => infer Return ? Return : never

Type parameters

Name
Type

Defined in

@rnv/core/lib/context/types.d.ts:302

---

NpmDepKey

Ƭ NpmDepKey: "dependencies" | "devDependencies" | "peerDependencies" | "optionalDependencies" | "resolutions"

Defined in

@rnv/core/lib/configs/types.d.ts:15

---

NpmPackageFile

Ƭ NpmPackageFile: Object

Type declaration

Name	Type
author?	string
dependencies?	Record<string, string>
description?	string
devDependencies?	Record<string, string>
license?	string
main?	string
name?	string
optionalDependencies?	Record<string, string>
peerDependencies?	Record<string, string>
resolutions?	Record<string, string>
version?	string

Defined in

@rnv/core/lib/configs/types.d.ts:1

---

NpmPackageFileKey

Ƭ NpmPackageFileKey: keyof NpmPackageFile

Defined in

@rnv/core/lib/configs/types.d.ts:14

---

OverridesOptions

Ƭ OverridesOptions: { override: string | number | undefined ; pattern: string }[]

Defined in

@rnv/core/lib/system/types.d.ts:28

---

ParamKeys

Ƭ ParamKeys<ExtraKeys>: Partial<Record<ProgramOptionsKey | ExtraKeys, ParamType>>

Type parameters

Name	Type
ExtraKeys	extends string = ProgramOptionsKey

Defined in

@rnv/core/lib/tasks/constants.d.ts:205

---

ParseFontsCallback

Ƭ ParseFontsCallback: (font: string, dir: string) => void

Type declaration

▸ (font, dir): void

Parameters

Name	Type
font	string
dir	string

Returns

void

Defined in

@rnv/core/lib/projects/types.d.ts:2

---

PlatPropKey

Ƭ PlatPropKey: keyof ConfigPlatformSchemaFragment

Defined in

@rnv/core/lib/schema/types.d.ts:72

---

PlatformBuildSchemeKey

Ƭ PlatformBuildSchemeKey: keyof ConfigPlatformBuildSchemeSchema

Defined in

@rnv/core/lib/schema/types.d.ts:74

---

PluginCallback

Ƭ PluginCallback: (plugin: RnvPlugin, pluginPlat: ConfigPluginPlatformSchema, key: string) => void

Type declaration

▸ (plugin, pluginPlat, key): void

Parameters

Name	Type
plugin	RnvPlugin
pluginPlat	ConfigPluginPlatformSchema
key	string

Returns

void

Defined in

@rnv/core/lib/plugins/types.d.ts:2

---

PluginListResponse

Ƭ PluginListResponse: Object

Type declaration

Name	Type
allPlugins	Record<string, PluginListResponseItem>
asArray	PluginListResponseItem[]
asString	string
plugins	string[]

Defined in

@rnv/core/lib/plugins/types.d.ts:3

---

PluginListResponseItem

Ƭ PluginListResponseItem: Object

Type declaration

Name	Type
name	string
props?	Record<string, string>
value	string
version?	string

Defined in

@rnv/core/lib/plugins/types.d.ts:9

---

ProgramOptionsKey

Ƭ ProgramOptionsKey: keyof typeof _RnvTaskOptions

Defined in

@rnv/core/lib/tasks/constants.d.ts:202

---

PromptOptions

Ƭ PromptOptions: Object

Type declaration

Name	Type
asString	string
keysAsArray	string[]
keysAsObject	Record<string, string>
optionsAsArray	any[]
valuesAsArray	any[]
valuesAsObject	Record<string, any>

Defined in

@rnv/core/lib/api/types.d.ts:93

---

PromptParams

Ƭ PromptParams: Object

Type declaration

Name	Type
choices?	({ name: string ; value: any } | string)[]
default?	any
initialValue?	string
logMessage?	string
loop?	boolean
message?	string
name?	string
pageSize?	number
source?	(answersSoFar: any, input: string | undefined) => Promise<any>
type	string
validate?	(i: string) => string | boolean
warningMessage?	string

Defined in

@rnv/core/lib/api/types.d.ts:101

---

PromptRenderFn

Ƭ PromptRenderFn: (i: number, obj: any, mapping: any, defaultVal: string) => string

Type declaration

▸ (i, obj, mapping, defaultVal): string

Parameters

Name	Type
i	number
obj	any
mapping	any
defaultVal	string

Returns

string

Defined in

@rnv/core/lib/api/types.d.ts:118

---

RenativeConfigVersion

Ƭ RenativeConfigVersion: string | { version: string }

Defined in

@rnv/core/lib/types.d.ts:4

---

ResolveOptions

Ƭ ResolveOptions: Object

Type declaration

Name	Type
basedir?	string
extensions?	string[]
forceForwardPaths?	boolean
keepSuffix?	boolean

Defined in

@rnv/core/lib/system/types.d.ts:2

---

RnvApi

Ƭ RnvApi: Object

Type declaration

Name	Type
analytics	RnvContextAnalytics
doResolve	DoResolveFn
fsExistsSync	typeof fs.existsSync
fsReadFileSync	(dest: fs.PathLike | undefined) => Buffer
fsReaddirSync	(dest: fs.PathLike | undefined) => string[]
fsWriteFileSync	(dest: string | undefined, data: string, options?: fs.WriteFileOptions) => void
getConfigProp	GetConfigPropFn
isDefault	boolean
logger	RnvApiLogger
path	typeof path
prompt	RnvApiPrompt
spinner	RnvApiSpinner

Defined in

@rnv/core/lib/api/types.d.ts:10

---

RnvApiChalk

Ƭ RnvApiChalk: Object

Type declaration

Name	Type
blue	RnvApiChalkFn
bold	RnvApiChalkFn
cyan	RnvApiChalkFn
gray	RnvApiChalkFn
green	RnvApiChalkFn
grey	RnvApiChalkFn
magenta	RnvApiChalkFn
red	RnvApiChalkFn
rgb	(red: number, green: number, blue: number) => any
white	RnvApiChalkFn
yellow	RnvApiChalkFn

Defined in

@rnv/core/lib/api/types.d.ts:49

---

RnvApiChalkFn

Ƭ RnvApiChalkFn: (v: any) => any & RnvApiChalk

Defined in

@rnv/core/lib/api/types.d.ts:62

---

RnvApiLogger

Ƭ RnvApiLogger: Object

Type declaration

Name	Type
chalk	() => RnvApiChalk
getCurrentCommand	(excludeDollar: boolean) => void
isInfoEnabled	() => boolean
logAndSave	(msg: string, skipLog?: boolean) => void
logAppInfo	(c: RnvContext) => void
logDebug	(...args: any[]) => void
logDefault	(task: string, customChalk?: any) => void
logError	(e: Error | string | unknown, opts?: { skipAnalytics: boolean }) => void
logExitTask	(task: string, customChalk?: (s: string) => string) => void
logHook	(hook: string, msg?: string) => void
logInfo	(msg: string) => void
logInitTask	(task: string, customChalk?: string | (s: string) => string) => void
logInitialize	() => void
logRaw	(...args: string[]) => void
logSuccess	(msg: string) => void
logSummary	(opts?: { header: string }) => void
logTask	(task: string, customChalk?: any) => void
logToSummary	(v: string, sanitizePaths?: () => string) => void
logWarning	(msg: string | boolean | unknown) => void
logWelcome	() => void
printArrIntoBox	(arr: string[], prefix?: string) => string
printBoxEnd	() => string
printBoxStart	(str: string, str2?: string) => string
printIntoBox	(str: string) => string

Defined in

@rnv/core/lib/api/types.d.ts:63

---

RnvApiPrompt

Ƭ RnvApiPrompt: Object

Type declaration

Name	Type
generateOptions	(inputData: any, isMultiChoice?: boolean, mapping?: any, renderMethod?: PromptRenderFn) => PromptOptions
inquirerPrompt	(options: PromptParams) => Promise<any>
inquirerSeparator	(text?: string) => any

Defined in

@rnv/core/lib/api/types.d.ts:32

---

RnvApiSpinner

Ƭ RnvApiSpinner: (msg: string | { text: string }) => { fail: RnvApiSpinner ; start: RnvApiSpinner ; succeed: RnvApiSpinner ; text: string }

Type declaration

▸ (msg): Object

Parameters

Name	Type
msg	string | { text: string }

Returns

Object

Name	Type
fail	RnvApiSpinner
start	RnvApiSpinner
succeed	RnvApiSpinner
text	string

Defined in

@rnv/core/lib/api/types.d.ts:24

---

RnvCLI

Ƭ RnvCLI: Record<string, object>

Defined in

@rnv/core/lib/system/types.d.ts:36

---

RnvContext

Ƭ RnvContext<Payload, ExtraOptionKeys>: Object

Type parameters

Name	Type
Payload	any
ExtraOptionKeys	extends string = ProgramOptionsKey

Type declaration

Name	Type	Description
_currentTask?	string	-
_renativePluginCache	Record<string, ConfigFilePlugin>	-
_requiresNpmInstall?	boolean	-
assetConfig	object	-
buildConfig	RnvContextBuildConfig	complete object containing ALL renative.*.json files collected and merged during execution
buildHooks	Record<string, (c: RnvContext) => Promise<void>>	-
buildPipes	Record<string, (c: RnvContext) => Promise<boolean>[]>	-
cli	Record<string, string | undefined>	-
command	string | null	first command value from cli (ie "rnv run -p android") returns "run"
configPropsInjects	OverridesOptions	-
engineConfigs	ConfigFileEngine[]	-
files	RnvContextFiles	-
injectableConfigProps	Record<string, ConfigProp[ConfigPropKey]>	-
isBuildHooksReady	boolean	-
isDefault	boolean	-
isSystemLinux	boolean	-
isSystemMac	boolean	-
isSystemWin	boolean	-
logging	{ containsError: boolean ; containsWarning: boolean ; logMessages: string[] }	-
logging.containsError	boolean	-
logging.containsWarning	boolean	-
logging.logMessages	string[]	-
mutations	{ pendingMutations: DependencyMutation[] }	-
mutations.pendingMutations	DependencyMutation[]	-
paths	RnvContextPaths	-
payload	Payload	Extra payload object used by 3rd party (ie @rnv/sdk-apple) to decorate context with extra typed information
platform	RnvPlatform	-
process	NodeJS.Process	-
program	RnvContextProgram<ExtraOptionKeys>	-
rnvVersion	string	-
runningProcesses	ExecaChildProcess[]	-
runtime	RnvContextRuntime	-
runtimePropsInjects	OverridesOptions	-
subCommand	string | null	second command value from cli (ie "rnv hooks list") returns "list"
supportedPlatforms	string[]	-
systemPropsInjects	OverridesOptions	-
timeEnd	Date	-
timeStart	Date	-

Defined in

@rnv/core/lib/context/types.d.ts:31

---

RnvContextAnalytics

Ƭ RnvContextAnalytics: Object

Type declaration

Name	Type
captureEvent	(ops: { platform?: RnvPlatform ; platforms?: string[] ; template?: string ; type: string }) => void
captureException	(e: string | Error, context: { extra: any }) => void
teardown	() => Promise<void>

Defined in

@rnv/core/lib/api/types.d.ts:37

---

RnvContextBuildConfig

Ƭ RnvContextBuildConfig: Partial<ConfigFileBuildConfig> & { _meta?: { currentAppConfigId: string } ; _refs?: Record<string, string> }

Defined in

@rnv/core/lib/context/types.d.ts:85

---

RnvContextFileKey

Ƭ RnvContextFileKey: "config" | "configLocal" | "configPrivate"

Defined in

@rnv/core/lib/context/types.d.ts:301

---

RnvContextFileObj

Ƭ RnvContextFileObj<T>: Object

Type parameters

Name
T

Type declaration

Name	Type
config?	T
configLocal?	ConfigFileLocal
configPrivate?	ConfigFilePrivate
config_original?	T
configs	T[]
configsLocal	ConfigFileLocal[]
configsPrivate	ConfigFilePrivate[]

Defined in

@rnv/core/lib/context/types.d.ts:169

---

RnvContextFiles

Ƭ RnvContextFiles: Object

Type declaration

Name	Type
appConfig	RnvContextFileObj<ConfigFileApp>
dotRnv	{ config: ConfigFileWorkspace ; configWorkspaces?: ConfigFileWorkspaces }
dotRnv.config	ConfigFileWorkspace
dotRnv.configWorkspaces?	ConfigFileWorkspaces
project	RnvContextFileObj<ConfigFileProject> & { assets: { config?: ConfigFileRuntime } ; builds: Record<string, ConfigFileBuildConfig> ; package: NpmPackageFile }
rnv	{ package: NpmPackageFile }
rnv.package	NpmPackageFile
rnvConfigTemplates	{ config?: ConfigFileTemplates ; package?: NpmPackageFile }
rnvConfigTemplates.config?	ConfigFileTemplates
rnvConfigTemplates.package?	NpmPackageFile
rnvCore	{ package: NpmPackageFile }
rnvCore.package	NpmPackageFile
scopedConfigTemplates	Record<string, ConfigFileTemplates>
workspace	RnvContextFileObj<ConfigFileWorkspace> & { appConfig: RnvContextFileObj<ConfigFileApp> ; project: RnvContextFileObj<ConfigFileProject> }

Defined in

@rnv/core/lib/context/types.d.ts:140

---

RnvContextPathObj

Ƭ RnvContextPathObj: Object

Type declaration

Name	Type
appConfigsDir	string
config	string
configExists?	boolean
configLocal	string
configLocalExists?	boolean
configPrivate	string
configPrivateExists?	boolean
configs	string[]
configsLocal	string[]
configsPrivate	string[]
dir	string
dirs	string[]
fontsDir	string
fontsDirs	string[]
pluginDirs	string[]

Defined in

@rnv/core/lib/context/types.d.ts:277

---

RnvContextPaths

Ƭ RnvContextPaths: Object

Type declaration

Name	Type
IS_LINKED	boolean
IS_NPX_MODE	boolean
appConfig	RnvContextPathObj
appConfigBase	string
buildHooks	{ dir: string ; dist: { dir: string ; index: string } ; src: { dir: string ; index: string ; indexTs: string } ; tsconfig: string }
buildHooks.dir	string
buildHooks.dist	{ dir: string ; index: string }
buildHooks.dist.dir	string
buildHooks.dist.index	string
buildHooks.src	{ dir: string ; index: string ; indexTs: string }
buildHooks.src.dir	string
buildHooks.src.index	string
buildHooks.src.indexTs	string
buildHooks.tsconfig	string
dotRnv	{ config: string ; configWorkspaces: string ; dir: string }
dotRnv.config	string
dotRnv.configWorkspaces	string
dotRnv.dir	string
project	RnvContextPathObj & { appConfigBase: { dir: string ; fontsDir: string ; fontsDirs: string[] ; pluginsDir: string } ; appConfigsDirNames: string[] ; appConfigsDirs: string[] ; assets: { config: string ; dir: string ; runtimeDir: string } ; babelConfig?: string ; builds: { config: string ; dir: string } ; dir: string ; dotRnvDir: string ; fontSourceDirs?: string[] ; nodeModulesDir: string ; package?: string ; platformTemplatesDirs: Record<string, string> ; srcDir?: string }
rnv	{ dir: string ; package: string }
rnv.dir	string
rnv.package	string
rnvConfigTemplates	{ config: string ; dir: string ; package: string ; pluginTemplatesDir: string }
rnvConfigTemplates.config	string
rnvConfigTemplates.dir	string
rnvConfigTemplates.package	string
rnvConfigTemplates.pluginTemplatesDir	string
rnvCore	{ dir: string ; package: string ; templateFilesDir: string }
rnvCore.dir	string
rnvCore.package	string
rnvCore.templateFilesDir	string
scopedConfigTemplates	{ configs: Record<string, string> ; pluginTemplatesDirs: Record<string, string> }
scopedConfigTemplates.configs	Record<string, string>
scopedConfigTemplates.pluginTemplatesDirs	Record<string, string>
template	{ appConfigBase: { dir: string } ; appConfigsDir: string ; assets: { dir: string } ; builds: { dir: string } ; config: string ; configTemplate: string ; dir: string }
template.appConfigBase	{ dir: string }
template.appConfigBase.dir	string
template.appConfigsDir	string
template.assets	{ dir: string }
template.assets.dir	string
template.builds	{ dir: string }
template.builds.dir	string
template.config	string
template.configTemplate	string
template.dir	string
user	{ currentDir: string ; homeDir: string }
user.currentDir	string
user.homeDir	string
workspace	RnvContextPathObj & { appConfig: RnvContextPathObj ; project: RnvContextPathObj & { appConfigBase: { dir: string } ; assets: string ; builds: string } }

Defined in

@rnv/core/lib/context/types.d.ts:178

---

RnvContextPlatform

Ƭ RnvContextPlatform: Object

Type declaration

Name	Type
engine?	RnvEngine
isConnected	boolean
isValid?	boolean
platform	RnvPlatformKey
port?	number

Defined in

@rnv/core/lib/context/types.d.ts:294

---

RnvContextProgram

Ƭ RnvContextProgram<ExtraKeys>: Object

Type parameters

Name	Type
ExtraKeys	extends string = never

Type declaration

Name	Type
allowUnknownOption	(p: boolean) => void
args?	string[]
isHelpInvoked?	boolean
option?	(cmd: string, desc: string) => void
opts	() => CamelCasedProperties<ParamKeys<ExtraKeys>>
outputHelp	() => void
parse?	(arg: string[]) => void
rawArgs?	string[]
showHelpAfterError	() => void

Defined in

@rnv/core/lib/context/types.d.ts:20

---

RnvContextRuntime

Ƭ RnvContextRuntime: Object

Type declaration

Name	Type
_platformBuildsSuffix?	string
_skipNativeDepResolutions	boolean
_skipPluginScopeWarnings	boolean
appConfigDir?	string
appDir?	string
appId?	string
availablePlatforms	RnvPlatformKey[]
bundleAssets	boolean
currentEngine?	RnvEngine
currentPlatform?	RnvEnginePlatform
currentTemplate?	string
disableReset	boolean
engine?	RnvEngine
enginesById	Record<string, RnvEngine>
enginesByIndex	RnvEngine[]
enginesByPlatform	Record<string, RnvEngine>
forceBuildHookRebuild	boolean
hasAllEnginesRegistered	boolean
hosted	boolean
integrationsByIndex	RnvIntegration[]
isTargetTrue	boolean
isWSConfirmed	boolean
localhost?	string
missingEnginePlugins	Record<string, string>
platform	RnvPlatform
platformBuildsProjectPath?	string
pluginVersions	Record<string, string>
plugins	Record<string, RnvPlugin>
port	number
requiresBootstrap	boolean
rnvVersionProject?	string
rnvVersionRunner?	string
runtimeExtraProps	Record<string, string>
scheme?	string
selectedWorkspace?	string
shouldOpenBrowser?	boolean
skipActiveServerCheck	boolean
skipBuildHooks	boolean
skipPackageUpdate?	boolean
supportedPlatforms	RnvContextPlatform[]
target?	string
targetUDID?	string
task?	string
timestamp?	number
versionCheckCompleted	boolean
webpackTarget?	string

Defined in

@rnv/core/lib/context/types.d.ts:91

---

RnvEngine

Ƭ RnvEngine<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
config	ConfigFileEngine
getContext	() => RnvContext<any, OKey>
originalTemplatePlatformProjectDir?	string
originalTemplatePlatformsDir?	string
outputDirName?	string
platforms	RnvEnginePlatforms
projectDirName	string
rootPath?	string
runtimeExtraProps	Record<string, string>
serverDirName	string
tasks	RnvTaskMap<OKey>

Defined in

@rnv/core/lib/engines/types.d.ts:18

---

RnvEngineInstallConfig

Ƭ RnvEngineInstallConfig: Object

Type declaration

Name	Type
configPath?	string
engineRootPath?	string
key	string
version?	string

Defined in

@rnv/core/lib/engines/types.d.ts:41

---

RnvEnginePlatform

Ƭ RnvEnginePlatform: Object

Type declaration

Name	Type
defaultPort	number
extensions	string[]
isWebHosted?	boolean

Defined in

@rnv/core/lib/engines/types.d.ts:31

---

RnvEnginePlatforms

Ƭ RnvEnginePlatforms: Partial<Record<RnvPlatformKey, RnvEnginePlatform>>

Defined in

@rnv/core/lib/engines/types.d.ts:5

---

RnvEngineTemplate

Ƭ RnvEngineTemplate: Object

Type declaration

Name	Type
id	string
packageName?	string

Defined in

@rnv/core/lib/engines/types.d.ts:36

---

RnvEngineTemplateMap

Ƭ RnvEngineTemplateMap: Record<string, RnvEngineTemplate>

Defined in

@rnv/core/lib/engines/types.d.ts:40

---

RnvEnvContext

Ƭ RnvEnvContext: Record<string, string | number | string[] | undefined | boolean>

Defined in

@rnv/core/lib/env/types.d.ts:1

---

RnvEnvContextOptions

Ƭ RnvEnvContextOptions: Object

Type declaration

Name	Type
exludeEnvKeys?	string[]
includedEnvKeys?	string[]

Defined in

@rnv/core/lib/env/types.d.ts:2

---

RnvError

Ƭ RnvError: any

Defined in

@rnv/core/lib/types.d.ts:7

---

RnvIntegration

Ƭ RnvIntegration<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
config	ConfigFileIntegration
getContext	() => RnvContext<any, OKey>
tasks	RnvTaskMap<OKey>

Defined in

@rnv/core/lib/integrations/types.d.ts:8

---

RnvPlatform

Ƭ RnvPlatform: RnvPlatformKey | null

Defined in

@rnv/core/lib/types.d.ts:3

---

RnvPlatformKey

Ƭ RnvPlatformKey: keyof typeof RnvPlatformName

Defined in

@rnv/core/lib/types.d.ts:2

---

RnvPlugin

Ƭ RnvPlugin: ConfigPluginSchema & { _id?: string ; _scopes?: string[] ; config?: ConfigFilePlugin ; packageName?: string ; scope?: string }

Defined in

@rnv/core/lib/plugins/types.d.ts:19

---

RnvPluginScope

Ƭ RnvPluginScope: Object

Type declaration

Name	Type
npmVersion?	string
scope	string

Defined in

@rnv/core/lib/plugins/types.d.ts:15

---

RnvSdk

Ƭ RnvSdk<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
getContext	() => RnvContext<any, OKey>
tasks	ReadonlyArray<RnvTask<OKey>>

Defined in

@rnv/core/lib/sdks/types.d.ts:6

---

RnvTask

Ƭ RnvTask<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
beforeDependsOn?	RnvTaskFn
dependsOn?	string[]
description	string
fn?	RnvTaskFn<OKey>
fnHelp?	RnvTaskHelpFn
forceBuildHookRebuild?	boolean
ignoreEngines?	boolean
isGlobalScope?	boolean
isPriorityOrder?	boolean
isPrivate?	boolean
key	string
options?	ReadonlyArray<RnvTaskOption<OKey>>
ownerID?	string
platforms?	RnvPlatformKey[]
task	string

Defined in

@rnv/core/lib/tasks/types.d.ts:18

---

RnvTaskFn

Ƭ RnvTaskFn<OKey>: (opts: { ctx: RnvContext<any, OKey> ; originTaskName: string | undefined ; parentTaskName: string | undefined ; shouldSkip: boolean ; taskName: string }) => Promise<any>

Type parameters

Name	Type
OKey	extends string = string

Type declaration

▸ (opts): Promise<any>

Parameters

Name	Type
opts	Object
opts.ctx	RnvContext<any, OKey>
opts.originTaskName	string | undefined
opts.parentTaskName	string | undefined
opts.shouldSkip	boolean
opts.taskName	string

Returns

Promise<any>

Defined in

@rnv/core/lib/tasks/types.d.ts:62

---

RnvTaskHelpFn

Ƭ RnvTaskHelpFn: () => Promise<void>

Type declaration

▸ (): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/tasks/types.d.ts:69

---

RnvTaskMap

Ƭ RnvTaskMap<OKey>: Record<string, RnvTask<OKey>>

Type parameters

Name	Type
OKey	extends string = string

Defined in

@rnv/core/lib/tasks/types.d.ts:61

---

RnvTaskOption

Ƭ RnvTaskOption<OKey>: Object

Type parameters

Name	Type
OKey	extends string = string

Type declaration

Name	Type
description	string
examples?	string[]
isRequired?	boolean
isValueType?	boolean
isVariadic?	boolean
key	OKey
shortcut?	string

Defined in

@rnv/core/lib/tasks/types.d.ts:52

---

RuntimePropKey

Ƭ RuntimePropKey: keyof RnvContextRuntime

Defined in

@rnv/core/lib/context/types.d.ts:139

---

TaskItemMap

Ƭ TaskItemMap: Record<string, { desc?: string ; taskKey: string }>

Defined in

@rnv/core/lib/tasks/types.d.ts:70

---

TaskObj

Ƭ TaskObj: Object

Type declaration

Name	Type
key	string
taskInstance	RnvTask

Defined in

@rnv/core/lib/tasks/types.d.ts:74

---

TaskPromptOption

Ƭ TaskPromptOption: Object

Type declaration

Name	Type
asArray?	string[]
command	string
description?	string
isGlobalScope?	boolean
isPriorityOrder?	boolean
isPrivate?	boolean
name	string
params?	RnvTaskOption[]
providers	string[]
subCommand?	string
subTasks?	TaskPromptOption[]
value	{ subTsks?: TaskPromptOption[] ; taskName: string }
value.subTsks?	TaskPromptOption[]
value.taskName	string

Defined in

@rnv/core/lib/tasks/types.d.ts:35

---

TimestampPathsConfig

Ƭ TimestampPathsConfig: Object

Type declaration

Name	Type
paths	string[]
timestamp	number

Defined in

@rnv/core/lib/system/types.d.ts:32

Variables

CoreEnvVars

• Const CoreEnvVars: Object

Type declaration

Name	Type
BASE	() => RnvEnvContext
RNV_EXTENSIONS	() => { RNV_EXTENSIONS: string[] }

Defined in

@rnv/core/lib/env/index.d.ts:2

---

DEFAULTS

• Const DEFAULTS: Object

Type declaration

Name	Type
author	string
backgroundColor	string
buildToolsVersion	string
certificateProfile	string
compileSdkVersion	number
deploymentTarget	string
devServerHost	string
gradleWrapperVersion	string
minSdkVersion	number
signingConfig	string
targetSdkVersion	number

Defined in

@rnv/core/lib/schema/defaults.d.ts:1

---

DEFAULT_TASK_DESCRIPTIONS

• Const DEFAULT_TASK_DESCRIPTIONS: Record<string, string>

Defined in

@rnv/core/lib/tasks/constants.d.ts:2

---

ExecOptionsPresets

• Const ExecOptionsPresets: Object

Type declaration

Name	Type
FIRE_AND_FORGET	ExecOptions
INHERIT_OUTPUT_NO_SPINNER	ExecOptions
NO_SPINNER_FULL_ERROR_SUMMARY	ExecOptions
SPINNER_FULL_ERROR_SUMMARY	ExecOptions

Defined in

@rnv/core/lib/system/exec.d.ts:3

---

RnvFileName

• Const RnvFileName: Object

Type declaration

Name	Type
package	"package.json"
renative	"renative.json"
renativeBuild	"renative.build.json"
renativeEngine	"renative.engine.json"
renativeLocal	"renative.local.json"
renativePlatforms	"renative.platforms.json"
renativePrivate	"renative.private.json"
renativeRuntime	"renative.runtime.json"
renativeTemplate	"renative.template.json"
renativeTemplates	"renative.templates.json"
renativeWorkspaces	"renative.workspaces.json"

Defined in

@rnv/core/lib/enums/fileName.d.ts:1

---

RnvFolderName

• Const RnvFolderName: Object

Type declaration

Name	Type
UP	".."
buildHooks	"buildHooks"
dotRnv	".rnv"
nodeModules	"node_modules"
npmCache	"npm_cache"
platformAssets	"platformAssets"
platformBuilds	"platformBuilds"
secrets	"secrets"
templateFiles	"templateFiles"
templateOverrides	"templateOverrides"

Defined in

@rnv/core/lib/enums/folderName.d.ts:1

---

RnvPlatformName

• Const RnvPlatformName: Object

Type declaration

Name	Type
android	"android"
androidtv	"androidtv"
androidwear	"androidwear"
chromecast	"chromecast"
firetv	"firetv"
ios	"ios"
kaios	"kaios"
linux	"linux"
macos	"macos"
tizen	"tizen"
tizenmobile	"tizenmobile"
tizenwatch	"tizenwatch"
tvos	"tvos"
web	"web"
webos	"webos"
webtv	"webtv"
windows	"windows"
xbox	"xbox"

Defined in

@rnv/core/lib/enums/platformName.d.ts:1

---

RnvPlatforms

• Const RnvPlatforms: readonly ["web", "ios", "android", "androidtv", "firetv", "tvos", "macos", "linux", "windows", "tizen", "webos", "chromecast", "kaios", "webtv", "androidwear", "tizenwatch", "tizenmobile", "xbox"]

Defined in

@rnv/core/lib/enums/platformName.d.ts:21

---

RnvTaskCoreOptionPresets

• Const RnvTaskCoreOptionPresets: Object

Type declaration

Name	Type
withCore	(arr?: RnvTaskOption[]) => RnvTaskOption[]

Defined in

@rnv/core/lib/tasks/constants.d.ts:206

---

RnvTaskName

• Const RnvTaskName: Object

Type declaration

Name	Type
appConfigure	"app configure"
appCreate	"app create"
appSwitch	"app switch"
build	"build"
clean	"clean"
config	"config"
configure	"configure"
configureSoft	"configureSoft"
cryptoDecrypt	"crypto decrypt"
cryptoEncrypt	"crypto encrypt"
cryptoInstallCerts	"crypto installCerts"
cryptoInstallProfile	"crypto installProfile"
cryptoInstallProfiles	"crypto installProfiles"
cryptoUpdateProfile	"crypto updateProfile"
cryptoUpdateProfiles	"crypto updateProfiles"
debug	"debug"
deploy	"deploy"
doctor	"doctor"
eject	"eject"
export	"export"
help	"help"
hooksList	"hooks list"
hooksPipes	"hooks pipes"
hooksRun	"hooks run"
info	"info"
kill	"kill"
link	"link"
log	"log"
new	"new"
package	"package"
pkg	"pkg"
platformConfigure	"platform configure"
platformConnect	"platform connect"
platformEject	"platform eject"
platformList	"platform list"
pluginAdd	"plugin add"
pluginList	"plugin list"
pluginUpdate	"plugin update"
projectConfigure	"project configure"
projectPlatforms	"project platforms"
projectUpgrade	"project upgrade"
publish	"publish"
run	"run"
sdkConfigure	"sdk configure"
start	"start"
status	"status"
switch	"switch"
target	"target"
targetLaunch	"target launch"
targetList	"target list"
telemetryDisable	"telemetry disable"
telemetryEnable	"telemetry enable"
telemetryStatus	"telemetry status"
templateAdd	"template add"
templateApply	"template apply"
templateList	"template list"
unlink	"unlink"
workspaceAdd	"workspace add"
workspaceConfigure	"workspace configure"
workspaceConnect	"workspace connect"
workspaceList	"workspace list"
workspaceUpdate	"workspace update"

Defined in

@rnv/core/lib/enums/taskName.d.ts:1

---

RnvTaskOptionPresets

• Const RnvTaskOptionPresets: Object

Type declaration

Name	Type
all	string[]
withAll	(arr?: RnvTaskOption[]) => RnvTaskOption[]
withConfigure	(arr?: RnvTaskOption[]) => RnvTaskOption[]
withRun	(arr?: RnvTaskOption[]) => RnvTaskOption[]

Defined in

@rnv/core/lib/tasks/constants.d.ts:209

---

RnvTaskOptions

• Const RnvTaskOptions: Record<"filter" | "engine" | "scheme" | "target" | "debug" | "device" | "info" | "platform" | "help" | "only" | "ci" | "mono" | "json" | "yes" | "unlinked" | "reset" | "hooks" | "host" | "port" | "hosted" | "printExec" | "skipTasks" | "maxErrorLength" | "telemetryDebug" | "packageManager" | "npxMode" | "configName" | "skipDependencyCheck" | "appConfigID" | "skipRnvCheck" | "exeMethod" | "resetHard" | "resetAssets" | "hostIp" | "debugIp" | "skipTargetCheck" | "resetAdb", RnvTaskOption>

Defined in

@rnv/core/lib/tasks/constants.d.ts:203

---

ZodFileSchema

• Const ZodFileSchema: Object

Type declaration

Name	Type
zodConfigFileApp	AnyZodObject
zodConfigFileEngine	ZodObject
zodConfigFileIntegration	ZodObject
zodConfigFileLocal	ZodObject
zodConfigFileOverrides	ZodObject
zodConfigFilePlugin	AnyZodObject
zodConfigFilePrivate	ZodObject
zodConfigFileProject	AnyZodObject
zodConfigFileRoot	AnyZodObject
zodConfigFileRuntime	ZodObject
zodConfigFileTemplate	AnyZodObject
zodConfigFileTemplates	AnyZodObject
zodConfigFileWorkspace	ZodObject
zodConfigFileWorkspaces	ZodObject

Defined in

@rnv/core/lib/schema/index.d.ts:22

---

ZodSharedSchema

• Const ZodSharedSchema: Object

Type declaration

Name	Type
_base	typeof _base
_common	typeof _common
_pAndroid	typeof _pAndroid
_pBase	typeof _pBase
_pIos	typeof _pIos
_platforms	typeof _platforms
_platformsFragmentsAndroid	typeof _platformsFragmentsAndroid
_platformsFragmentsBase	typeof _platformsFragmentsBase
_platformsFragmentsElectron	typeof _platformsFragmentsElectron
_platformsFragmentsIos	typeof _platformsFragmentsIos
_platformsFragmentsLightning	typeof _platformsFragmentsLightning
_platformsFragmentsNextJs	typeof _platformsFragmentsNextJs
_platformsFragmentsReactNative	typeof _platformsFragmentsReactNative
_platformsFragmentsTemplateAndroid	typeof _platformsFragmentsTemplateAndroid
_platformsFragmentsTemplateXcode	typeof _platformsFragmentsTemplateXcode
_platformsFragmentsTizen	typeof _platformsFragmentsTizen
_platformsFragmentsWeb	typeof _platformsFragmentsWeb
_platformsFragmentsWebos	typeof _platformsFragmentsWebos
_platformsFragmentsWindows	typeof _platformsFragmentsWindows
_plugins	typeof _plugins
_shared	typeof _shared

Defined in

@rnv/core/lib/schema/index.d.ts:533

---

isSystemLinux

• Const isSystemLinux: boolean

Defined in

@rnv/core/lib/system/is.d.ts:2

---

isSystemMac

• Const isSystemMac: boolean

Defined in

@rnv/core/lib/system/is.d.ts:1

---

isSystemWin

• Const isSystemWin: boolean

Defined in

@rnv/core/lib/system/is.d.ts:3

---

openCommand

• Const openCommand: string

Defined in

@rnv/core/lib/system/exec.d.ts:45

Functions

applyTemplate

▸ applyTemplate(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/templates/index.d.ts:3

---

areNodeModulesInstalled

▸ areNodeModulesInstalled(): boolean

Returns

boolean

Defined in

@rnv/core/lib/projects/npm.d.ts:3

---

arrayMerge

▸ arrayMerge(destinationArray, sourceArray): string[]

Parameters

Name	Type
destinationArray	string[]
sourceArray	string[]

Returns

string[]

Defined in

@rnv/core/lib/system/fs.d.ts:40

---

buildHooks

▸ buildHooks(): Promise<true>

Returns

Promise<true>

Defined in

@rnv/core/lib/buildHooks/index.d.ts:2

---

chalk

▸ chalk(): RnvApiChalk

Returns

RnvApiChalk

Defined in

@rnv/core/lib/logger/index.d.ts:2

---

checkAndCreateProjectPackage

▸ checkAndCreateProjectPackage(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/package.d.ts:3

---

checkAndMigrateProject

▸ checkAndMigrateProject(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/migrator/index.d.ts:1

---

checkForPluginDependencies

▸ checkForPluginDependencies(postInjectHandler?): Promise<void>

Parameters

Name	Type
postInjectHandler?	AsyncCallback

Returns

Promise<void>

Defined in

@rnv/core/lib/plugins/index.d.ts:11

---

checkIfProjectAndNodeModulesExists

▸ checkIfProjectAndNodeModulesExists(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/projects/npm.d.ts:1

---

checkNpxIsInstalled

▸ checkNpxIsInstalled(): Promise<true>

Returns

Promise<true>

Defined in

@rnv/core/lib/projects/npm.d.ts:2

---

cleanEmptyFoldersRecursively

▸ cleanEmptyFoldersRecursively(folder): void

Parameters

Name	Type
folder	string

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:50

---

cleanFolder

▸ cleanFolder(d): Promise<void>

Parameters

Name	Type
d	string

Returns

Promise<void>

Defined in

@rnv/core/lib/system/fs.d.ts:30

---

cleanNodeModules

▸ cleanNodeModules(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/projects/npm.d.ts:7

---

cleanPlaformAssets

▸ cleanPlaformAssets(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/assets.d.ts:5

---

cleanPlatformBuild

▸ cleanPlatformBuild(platform, cleanAllPlatforms?): Promise<void>

Parameters

Name	Type
platform	RnvPlatform
cleanAllPlatforms?	boolean

Returns

Promise<void>

Defined in

@rnv/core/lib/platforms/index.d.ts:7

---

commandExists

▸ commandExists(commandName, callback?): Promise<unknown>

Parameters

Name	Type
commandName	string
callback?	ExecCallback

Returns

Promise<unknown>

Defined in

@rnv/core/lib/system/exec.d.ts:43

---

commandExistsSync

▸ commandExistsSync(commandName): boolean

Parameters

Name	Type
commandName	string

Returns

boolean

Defined in

@rnv/core/lib/system/exec.d.ts:44

---

configureEngines

▸ configureEngines(c): Promise<boolean>

Parameters

Name	Type
c	RnvContext

Returns

Promise<boolean>

Defined in

@rnv/core/lib/engines/index.d.ts:9

---

configurePlugins

▸ configurePlugins(): Promise<true>

Returns

Promise<true>

Defined in

@rnv/core/lib/plugins/index.d.ts:6

---

configureRuntimeDefaults

▸ configureRuntimeDefaults(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/context/runtime.d.ts:1

---

configureTemplateFiles

▸ configureTemplateFiles(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/templates/index.d.ts:1

---

copyAssetsFolder

▸ copyAssetsFolder(subPath?, customFn?): Promise<void>

Parameters

Name	Type
subPath?	string
customFn?	(c: RnvContext, platform: RnvPlatform) => void

Returns

Promise<void>

Defined in

@rnv/core/lib/projects/assets.d.ts:4

---

copyBuildsFolder

▸ copyBuildsFolder(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/projects/appConfig.d.ts:1

---

copyContentsIfNotExistsRecursiveSync

▸ copyContentsIfNotExistsRecursiveSync(src, dest): void

Parameters

Name	Type
src	string
dest	string

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:52

---

copyFileSync

▸ copyFileSync(source, target, skipOverride?, timestampPathsConfig?): void

Parameters

Name	Type
source	string
target	string
skipOverride?	boolean
timestampPathsConfig?	TimestampPathsConfig

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:20

---

copyFileWithInjectSync

▸ copyFileWithInjectSync(source, target, skipOverride?, injectObject?, timestampPathsConfig?, c?): void

Parameters

Name	Type
source	string
target	string
skipOverride?	boolean
injectObject?	OverridesOptions
timestampPathsConfig?	TimestampPathsConfig
c?	RnvContext

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:23

---

copyFolderContentsRecursive

▸ copyFolderContentsRecursive(source, target, convertSvg?, skipPaths?): Promise<void>

Parameters

Name	Type
source	string
target	string
convertSvg?	boolean
skipPaths?	boolean

Returns

Promise<void>

Defined in

@rnv/core/lib/system/fs.d.ts:26

---

copyFolderContentsRecursiveSync

▸ copyFolderContentsRecursiveSync(source, target, convertSvg?, skipPaths?, skipOverride?, injectObject?, timestampPathsConfig?, c?, extFilter?): void

Parameters

Name	Type
source	string
target	string
convertSvg?	boolean
skipPaths?	string[]
skipOverride?	boolean
injectObject?	OverridesOptions
timestampPathsConfig?	TimestampPathsConfig
c?	RnvContext
extFilter?	string[]

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:25

---

copyFolderRecursiveSync

▸ copyFolderRecursiveSync(source, target, convertSvg?, skipOverride?, injectObject?, timestampPathsConfig?, c?, extFilter?): void

Parameters

Name	Type
source	string
target	string
convertSvg?	boolean
skipOverride?	boolean
injectObject?	OverridesOptions
timestampPathsConfig?	TimestampPathsConfig
c?	RnvContext
extFilter?	string[]

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:24

---

copyRuntimeAssets

▸ copyRuntimeAssets(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/assets.d.ts:3

---

copySharedPlatforms

▸ copySharedPlatforms(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/platforms/index.d.ts:10

---

copyTemplatePluginsSync

▸ copyTemplatePluginsSync(c): void

Parameters

Name	Type
c	RnvContext

Returns

void

Defined in

@rnv/core/lib/plugins/index.d.ts:13

---

createDependencyMutation

▸ createDependencyMutation(opts): DependencyMutation

Parameters

Name	Type
opts	DependencyMutation

Returns

DependencyMutation

Defined in

@rnv/core/lib/projects/mutations.d.ts:2

---

createPlatformBuild

▸ createPlatformBuild(platform): Promise<void>

Parameters

Name	Type
platform	RnvPlatform

Returns

Promise<void>

Defined in

@rnv/core/lib/platforms/index.d.ts:8

---

createRnvApi

▸ createRnvApi(_api?): void

Parameters

Name	Type
_api?	Object
_api.analytics	RnvContextAnalytics
_api.doResolve	DoResolveFn
_api.getConfigProp	<T>(key: T, defaultVal?: ConfigPlatformSchemaFragment[T], obj?: Partial<ConfigFileBuildConfig>) => ConfigPlatformSchemaFragment[T]
_api.logger	RnvApiLogger
_api.prompt	RnvApiPrompt
_api.spinner	RnvApiSpinner

Returns

void

Defined in

@rnv/core/lib/api/index.d.ts:3

---

createRnvContext

▸ createRnvContext(ctxOpts?): void

Parameters

Name	Type
ctxOpts?	CreateContextOptions

Returns

void

Defined in

@rnv/core/lib/context/index.d.ts:3

---

createRnvEngine

▸ createRnvEngine<OKey>(opts): RnvEngine<OKey>

Type parameters

Name	Type
OKey	extends string

Parameters

Name	Type
opts	CreateRnvEngineOpts<OKey>

Returns

RnvEngine<OKey>

Defined in

@rnv/core/lib/engines/creator.d.ts:2

---

createRnvIntegration

▸ createRnvIntegration<OKey>(opts): RnvIntegration<OKey>

Type parameters

Name	Type
OKey	extends string

Parameters

Name	Type
opts	CreateRnvIntegrationOpts<OKey>

Returns

RnvIntegration<OKey>

Defined in

@rnv/core/lib/integrations/creator.d.ts:2

---

createRnvSDK

▸ createRnvSDK<OKey>(opts): RnvSdk<OKey>

Type parameters

Name	Type
OKey	extends string

Parameters

Name	Type
opts	CreateRnvSdkOpts<OKey>

Returns

RnvSdk<OKey>

Defined in

@rnv/core/lib/sdks/creator.d.ts:2

---

createTask

▸ createTask<OKey>(task): RnvTask<OKey>

Type parameters

Name	Type
OKey	extends string

Parameters

Name	Type
task	CreateRnvTaskOpt<OKey>

Returns

RnvTask<OKey>

Defined in

@rnv/core/lib/tasks/creators.d.ts:2

---

createTaskOptionsMap

▸ createTaskOptionsMap(): void

Returns

void

Defined in

@rnv/core/lib/tasks/creators.d.ts:3

---

createWorkspace

▸ createWorkspace(workspaceID, workspacePath): Promise<true>

Parameters

Name	Type
workspaceID	string
workspacePath	string

Returns

Promise<true>

Defined in

@rnv/core/lib/configs/workspaces.d.ts:3

---

doResolve

▸ doResolve(aPath?, mandatory?, options?): string

An attempt at drying out filesystem references to external packages.

We access external packages for a number of reasons:

• to simply resolve a non-scoped package's (absolute) path on disk. e.g. '/var/project/node_modules/react-native'
• to resolve a scoped package's (absolute) path on disk. e.g. '/var/project/node_modules/@aScope/react-native'
• to resolve an individual file/dir's (absolute) path on disk. e.g. '/var/project/node_modules/react-native/blur/android' (note this is a normally illegal package reference)
• to resolve an individual file (absolute) path on disk by FS relative reference. e.g. '/var/project/node_modules/react-native/relPath'

** Please note that we do not support subpackage paths. All suffixed paths (e.g. 'react-native/SUFFIX_PATH', '@aScope/react-native/SUFFIX_PATH') will be treated as a filepath from root of resolved package (i.e. will ignore subdirectory package.json)

Parameters

Name	Type	Description
aPath?	string	package name. e.g. 'file:../rel/path', 'react-native', 'react-native/android', '@react-native-community/masked-view/android'
mandatory?	boolean	whether it throws
options?	ResolveOptions	docs - https://tinyurl.com/r9sfpf7 && {keepSuffix: boolean}

Returns

string

Defined in

@rnv/core/lib/system/resolve.d.ts:18

---

doResolvePath

▸ doResolvePath(aPath, mandatory?, options?, fallbackBase?): string

Parameters

Name	Type
aPath	string
mandatory?	boolean
options?	ResolveOptions
fallbackBase?	string

Returns

string

Defined in

@rnv/core/lib/system/resolve.d.ts:19

---

ejectPlatform

▸ ejectPlatform(platform): void

Parameters

Name	Type
platform	string

Returns

void

Defined in

@rnv/core/lib/platforms/index.d.ts:11

---

execCLI

▸ execCLI(cli, command, opts?): Promise<string>

Execute CLI command

Parameters

Name	Type	Description
cli	string	the cli to be executed
command	string	the command to be executed
opts?	ExecOptions	the options for the command

Returns

Promise<string>

Defined in

@rnv/core/lib/system/exec.d.ts:20

---

execaCommand

▸ execaCommand(cmd, options?): ExecaChildProcess<string>

Parameters

Name	Type
cmd	string
options?	Options<string>

Returns

ExecaChildProcess<string>

Defined in

@rnv/core/lib/system/exec.d.ts:31

---

executeAsync

▸ executeAsync(cmd, opts?): Promise<string>

Execute a plain command

Parameters

Name	Type	Description
cmd	string | string[]	-
opts?	ExecOptions	the options for the command

Returns

Promise<string>

Defined in

@rnv/core/lib/system/exec.d.ts:30

---

executePipe

▸ executePipe(key): Promise<void>

Parameters

Name	Type
key	string

Returns

Promise<void>

Defined in

@rnv/core/lib/buildHooks/index.d.ts:1

---

executeRnvCore

▸ executeRnvCore(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/runner.d.ts:2

---

executeTask

▸ executeTask(opts): Promise<undefined>

Parameters

Name	Type
opts	Object
opts.alternativeTaskInOnlyMode?	string
opts.isFirstTask?	boolean
opts.isOptional?	boolean
opts.originTaskName?	string
opts.parentTaskName?	string
opts.skipInOnlyMode?	boolean
opts.taskName	string

Returns

Promise<undefined>

Defined in

@rnv/core/lib/tasks/taskExecutors.d.ts:2

---

executeTelnet

▸ executeTelnet(port, command): Promise<string>

Connect to a local telnet server and execute a command

Parameters

Name	Type	Description
port	string	where do you want me to connect to?
command	string	the command to be executed once I'm connected

Returns

Promise<string>

Defined in

@rnv/core/lib/system/exec.d.ts:41

---

exitRnvCore

▸ exitRnvCore(code): Promise<void>

Parameters

Name	Type
code	number

Returns

Promise<void>

Defined in

@rnv/core/lib/runner.d.ts:1

---

extractSingleExecutableTask

▸ extractSingleExecutableTask(suitableTasks, taskName): Promise<RnvTask>

Parameters

Name	Type
suitableTasks	RnvTask[]
taskName	string

Returns

Promise<RnvTask>

Defined in

@rnv/core/lib/tasks/taskFinder.d.ts:7

---

findSuitableTask

▸ findSuitableTask(): Promise<RnvTask>

Returns

Promise<RnvTask>

Defined in

@rnv/core/lib/tasks/taskFinder.d.ts:2

---

findTasksByTaskName

▸ findTasksByTaskName(taskName): Object

Parameters

Name	Type
taskName	string

Returns

Object

Name	Type
available	RnvTask<string>[]
match	RnvTask[]

Defined in

@rnv/core/lib/tasks/taskFinder.d.ts:3

---

fixPackageJson

▸ fixPackageJson(c, pkgPath): Promise<void>

Parameters

Name	Type
c	RnvContext
pkgPath	string

Returns

Promise<void>

Defined in

@rnv/core/lib/formatter/index.d.ts:2

---

fixPackageObject

▸ fixPackageObject(pp): Record<string, unknown>

Parameters

Name	Type
pp	Record<string, unknown>

Returns

Record<string, unknown>

Defined in

@rnv/core/lib/formatter/index.d.ts:3

---

formatBytes

▸ formatBytes(bytes, decimals?): string

Parameters

Name	Type
bytes	number
decimals?	number

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:48

---

fsChmodSync

▸ fsChmodSync(dest, flag): void

Parameters

Name	Type
dest	PathLike
flag	Mode

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:12

---

fsCopyFileSync

▸ fsCopyFileSync(source, dest): void

Parameters

Name	Type
source	string
dest	string

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:7

---

fsExistsSync

▸ fsExistsSync(dest): boolean

Parameters

Name	Type
dest	PathLike

Returns

boolean

Defined in

@rnv/core/lib/system/fs.d.ts:8

---

fsLstatSync

▸ fsLstatSync(dest): Stats

Parameters

Name	Type
dest	PathLike

Returns

Stats

Defined in

@rnv/core/lib/system/fs.d.ts:10

---

fsMkdirSync

▸ fsMkdirSync(arg1): void

Parameters

Name	Type
arg1	PathLike

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:15

---

fsReadFile

▸ fsReadFile(arg1, arg2): void

Parameters

Name	Type
arg1	PathLike
arg2	(err: unknown, data: Buffer) => void

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:18

---

fsReadFileSync

▸ fsReadFileSync(dest): Buffer

Parameters

Name	Type
dest	PathLike

Returns

Buffer

Defined in

@rnv/core/lib/system/fs.d.ts:11

---

fsReaddir

▸ fsReaddir(arg1, arg2): void

Parameters

Name	Type
arg1	PathLike
arg2	(err: unknown, files: string[]) => void

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:19

---

fsReaddirSync

▸ fsReaddirSync(dest): string[]

Parameters

Name	Type
dest	PathLike

Returns

string[]

Defined in

@rnv/core/lib/system/fs.d.ts:9

---

fsRenameSync

▸ fsRenameSync(arg1, arg2): void

Parameters

Name	Type
arg1	PathLike
arg2	PathLike

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:13

---

fsStatSync

▸ fsStatSync(arg1): Stats

Parameters

Name	Type
arg1	PathLike

Returns

Stats

Defined in

@rnv/core/lib/system/fs.d.ts:14

---

fsSymlinkSync

▸ fsSymlinkSync(arg1, arg2): void

Parameters

Name	Type
arg1	PathLike
arg2	PathLike

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:17

---

fsUnlinkSync

▸ fsUnlinkSync(arg1): void

Parameters

Name	Type
arg1	PathLike

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:16

---

fsWriteFileSync

▸ fsWriteFileSync(dest, data, options?): void

Parameters

Name	Type
dest	string
data	string
options?	WriteFileOptions

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:6

---

generateBuildConfig

▸ generateBuildConfig(): void

Returns

void

Defined in

@rnv/core/lib/configs/buildConfig.d.ts:1

---

generateContextDefaults

▸ generateContextDefaults(): RnvContext

Returns

RnvContext

Defined in

@rnv/core/lib/context/defaults.d.ts:8

---

generateContextPaths

▸ generateContextPaths(pathObj, dir, configName?): void

Parameters

Name	Type
pathObj	RnvContextPathObj
dir	string
configName?	string

Returns

void

Defined in

@rnv/core/lib/context/index.d.ts:2

---

generateDefaultChalk

▸ generateDefaultChalk(): RnvApiChalk

Returns

RnvApiChalk

Defined in

@rnv/core/lib/logger/defaults.d.ts:2

---

generateEngineExtensions

▸ generateEngineExtensions(exts, config): string[]

Parameters

Name	Type
exts	string[]
config	Object
config.custom?	any
config.engineExtension?	string
config.id?	string
config.npm?	Object
config.npm.dependencies?	Record<string, string>
config.npm.devDependencies?	Record<string, string>
config.npm.optionalDependencies?	Record<string, string>
config.npm.peerDependencies?	Record<string, string>
config.overview?	string
config.packageName?	string
config.platforms?	Partial<Record<"android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox", { engine?: string ; npm?: { dependencies?: Record<string, string> ; devDependencies?: Record<string, string> ; optionalDependencies?: Record<string, string> ; peerDependencies?: Record<string, string> } }>>
config.plugins?	Record<string, string>

Returns

string[]

Defined in

@rnv/core/lib/engines/index.d.ts:8

---

generateLocalConfig

▸ generateLocalConfig(resetAppId?): void

Parameters

Name	Type
resetAppId?	boolean

Returns

void

Defined in

@rnv/core/lib/configs/configLocal.d.ts:1

---

generateLocalJsonSchemas

▸ generateLocalJsonSchemas(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/schema/schemaManager.d.ts:1

---

generateOptions

▸ generateOptions(inputData, isMultiChoice?, mapping?, renderMethod?): PromptOptions

Parameters

Name	Type
inputData	any
isMultiChoice?	boolean
mapping?	any
renderMethod?	PromptRenderFn

Returns

PromptOptions

Defined in

@rnv/core/lib/api/index.d.ts:13

---

generatePlatformAssetsRuntimeConfig

▸ generatePlatformAssetsRuntimeConfig(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/configs/platformAssets.d.ts:1

---

generatePlatformChoices

▸ generatePlatformChoices(): { isConnected: boolean ; name: string ; value: "android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox" }[]

Returns

{ isConnected: boolean ; name: string ; value: "android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox" }[]

Defined in

@rnv/core/lib/platforms/index.d.ts:2

---

generatePlatformTemplatePaths

▸ generatePlatformTemplatePaths(): void

Returns

void

Defined in

@rnv/core/lib/configs/configProject.d.ts:7

---

generateRnvConfigFileObj

▸ generateRnvConfigFileObj(): Object

Returns

Object

Name	Type
configs	never[]
configsLocal	never[]
configsPrivate	never[]

Defined in

@rnv/core/lib/context/defaults.d.ts:3

---

generateRnvConfigPathObj

▸ generateRnvConfigPathObj(): RnvContextPathObj

Returns

RnvContextPathObj

Defined in

@rnv/core/lib/context/defaults.d.ts:2

---

generateRnvTaskMap

▸ generateRnvTaskMap<OKey>(taskArr, config): RnvTaskMap<OKey>

Type parameters

Name	Type
OKey	extends string

Parameters

Name	Type
taskArr	readonly RnvTask<OKey>[]
config	Object
config.name?	string
config.packageName?	string

Returns

RnvTaskMap<OKey>

Defined in

@rnv/core/lib/tasks/taskHelpers.d.ts:4

---

generateStringFromTaskOption

▸ generateStringFromTaskOption(opt): string

Parameters

Name	Type
opt	RnvTaskOption

Returns

string

Defined in

@rnv/core/lib/tasks/taskHelpers.d.ts:8

---

getApi

▸ getApi(): RnvApi

Returns

RnvApi

Defined in

@rnv/core/lib/api/provider.d.ts:2

---

getAppConfigBuildsFolder

▸ getAppConfigBuildsFolder(customPath?): string

Parameters

Name	Type
customPath?	string

Returns

string

Defined in

@rnv/core/lib/context/contextProps.d.ts:9

---

getAppFolder

▸ getAppFolder(isRelativePath?): string

Parameters

Name	Type
isRelativePath?	boolean

Returns

string

Defined in

@rnv/core/lib/context/contextProps.d.ts:7

---

getConfigProp

▸ getConfigProp<T, K>(key, obj?): GetConfigPropVal<T, K>

Type parameters

Name	Type
T	T
K	extends string | number | symbol

Parameters

Name	Type
key	K
obj?	Partial<ConfigFileBuildConfig>

Returns

GetConfigPropVal<T, K>

Defined in

@rnv/core/lib/context/contextProps.d.ts:4

---

getConfigRootProp

▸ getConfigRootProp<T, K>(key): GetConfigRootPropVal<T, K>

Type parameters

Name	Type
T	T
K	extends string | number | symbol

Parameters

Name	Type
key	K

Returns

GetConfigRootPropVal<T, K>

Defined in

@rnv/core/lib/context/contextProps.d.ts:3

---

getContext

▸ getContext<C, T>(): RnvContext<C, T>

Type parameters

Name	Type
C	any
T	extends string = "filter" | "platform" | "port" | "reset" | "target" | "host" | "json" | "unlinked" | "engine" | "scheme" | "debug" | "device" | "info" | "help" | "only" | "ci" | "mono" | "yes" | "hooks" | "hosted" | "printExec" | "skipTasks" | "maxErrorLength" | "telemetryDebug" | "packageManager" | "npxMode" | "configName" | "skipDependencyCheck" | "appConfigID" | "skipRnvCheck" | "exeMethod" | "resetHard" | "resetAssets" | "hostIp" | "debugIp" | "skipTargetCheck" | "resetAdb"

Returns

RnvContext<C, T>

Defined in

@rnv/core/lib/context/provider.d.ts:2

---

getCurrentCommand

▸ getCurrentCommand(excludeDollar): void

Parameters

Name	Type
excludeDollar	boolean

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:5

---

getDirectories

▸ getDirectories(source): string[]

Parameters

Name	Type
source	string

Returns

string[]

Defined in

@rnv/core/lib/system/fs.d.ts:49

---

getEngineRunnerByOwnerID

▸ getEngineRunnerByOwnerID(task): RnvEngine

Parameters

Name	Type
task	RnvTask

Returns

RnvEngine

Defined in

@rnv/core/lib/engines/index.d.ts:17

---

getEngineRunnerByPlatform

▸ getEngineRunnerByPlatform(platform, ignoreMissingError?): RnvEngine

Parameters

Name	Type
platform	RnvPlatform
ignoreMissingError?	boolean

Returns

RnvEngine

Defined in

@rnv/core/lib/engines/index.d.ts:16

---

getEngineTemplateByPlatform

▸ getEngineTemplateByPlatform(platform): RnvEngineTemplate

Parameters

Name	Type
platform	RnvPlatform

Returns

RnvEngineTemplate

Defined in

@rnv/core/lib/configs/engines.d.ts:3

---

getFileListSync

▸ getFileListSync(dir): string[]

Parameters

Name	Type
dir	PathLike

Returns

string[]

Defined in

@rnv/core/lib/system/fs.d.ts:46

---

getFlavouredProp

▸ getFlavouredProp<T, K>(obj, key): T[K]

Type parameters

Name	Type
T	T
K	extends string | number | symbol

Parameters

Name	Type
obj	T
key	K

Returns

T[K]

Defined in

@rnv/core/lib/context/contextProps.d.ts:5

---

getLocalRenativePlugin

▸ getLocalRenativePlugin(): Object

Returns

Object

Name	Type
version	string
webpack	{ moduleAliases: { renative: { projectPath: string } } ; modulePaths: never[] }
webpack.moduleAliases	{ renative: { projectPath: string } }
webpack.moduleAliases.renative	{ projectPath: string }
webpack.moduleAliases.renative.projectPath	string
webpack.modulePaths	never[]

Defined in

@rnv/core/lib/plugins/index.d.ts:16

---

getMergedPlugin

▸ getMergedPlugin(c, key): RnvPlugin

Parameters

Name	Type
c	RnvContext
key	string

Returns

RnvPlugin

Defined in

@rnv/core/lib/plugins/index.d.ts:5

---

getPlatformProjectDir

▸ getPlatformProjectDir(): string

Returns

string

Defined in

@rnv/core/lib/context/contextProps.d.ts:8

---

getRealPath

▸ getRealPath(p, key?, original?): string

Parameters

Name	Type
p	string
key?	string
original?	string

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:39

---

getRegisteredEngines

▸ getRegisteredEngines(): RnvEngine[]

Returns

RnvEngine[]

Defined in

@rnv/core/lib/engines/index.d.ts:18

---

getRegisteredTasks

▸ getRegisteredTasks(): RnvTaskMap

Returns

RnvTaskMap

Defined in

@rnv/core/lib/tasks/taskRegistry.d.ts:3

---

getRelativePath

▸ getRelativePath(from, to): string

Parameters

Name	Type
from	string
to	string

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:51

---

getTaskNameFromCommand

▸ getTaskNameFromCommand(): string

Returns

string

Defined in

@rnv/core/lib/tasks/taskHelpers.d.ts:3

---

getTimestampPathsConfig

▸ getTimestampPathsConfig(): TimestampPathsConfig

Returns

TimestampPathsConfig

Defined in

@rnv/core/lib/context/contextProps.d.ts:6

---

getWorkspaceConnectionString

▸ getWorkspaceConnectionString(obj?): any

Parameters

Name	Type
obj?	Object
obj.path	string
obj.remote?	Object
obj.remote.type	string
obj.remote.url	string

Returns

any

Defined in

@rnv/core/lib/configs/workspaces.d.ts:5

---

getWorkspaceDirPath

▸ getWorkspaceDirPath(c): Promise<string>

Parameters

Name	Type
c	RnvContext

Returns

Promise<string>

Defined in

@rnv/core/lib/configs/workspaces.d.ts:4

---

getWorkspaceOptions

▸ getWorkspaceOptions(): PromptOptions

Returns

PromptOptions

Defined in

@rnv/core/lib/configs/workspaces.d.ts:6

---

handleMutations

▸ handleMutations(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/mutations.d.ts:3

---

includesPluginPath

▸ includesPluginPath(str?): boolean

Parameters

Name	Type
str?	string

Returns

boolean

Defined in

@rnv/core/lib/plugins/index.d.ts:15

---

initializeTask

▸ initializeTask(taskInstance): Promise<boolean>

Parameters

Name	Type
taskInstance	RnvTask

Returns

Promise<boolean>

Defined in

@rnv/core/lib/tasks/taskExecutors.d.ts:11

---

inquirerPrompt

▸ inquirerPrompt(options): Promise<any>

Parameters

Name	Type
options	PromptParams

Returns

Promise<any>

Defined in

@rnv/core/lib/api/index.d.ts:11

---

inquirerSeparator

▸ inquirerSeparator(text?): any

Parameters

Name	Type
text?	string

Returns

any

Defined in

@rnv/core/lib/api/index.d.ts:12

---

installEngines

▸ installEngines(failOnMissingDeps?): Promise<boolean>

Parameters

Name	Type
failOnMissingDeps?	boolean

Returns

Promise<boolean>

Defined in

@rnv/core/lib/engines/index.d.ts:14

---

installPackageDependencies

▸ installPackageDependencies(failOnError?): Promise<boolean>

Parameters

Name	Type
failOnError?	boolean

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/npm.d.ts:6

---

isInfoEnabled

▸ isInfoEnabled(): boolean

Returns

boolean

Defined in

@rnv/core/lib/logger/index.d.ts:17

---

isPlatformActive

▸ isPlatformActive(resolve?): boolean

Parameters

Name	Type
resolve?	() => void

Returns

boolean

Defined in

@rnv/core/lib/platforms/index.d.ts:9

---

isScopedPackagePath

▸ isScopedPackagePath(aPath): true

Parameters

Name	Type
aPath	string

Returns

true

Defined in

@rnv/core/lib/system/resolve.d.ts:20

---

isTemplateInstalled

▸ isTemplateInstalled(): string | false

Returns

string | false

Defined in

@rnv/core/lib/templates/index.d.ts:2

---

isYarnInstalled

▸ isYarnInstalled(): string | true

Returns

string | true

Defined in

@rnv/core/lib/projects/npm.d.ts:5

---

listAndSelectNpmVersion

▸ listAndSelectNpmVersion(npmPackage): Promise<any>

Parameters

Name	Type
npmPackage	string

Returns

Promise<any>

Defined in

@rnv/core/lib/projects/npm.d.ts:4

---

listAppConfigsFoldersSync

▸ listAppConfigsFoldersSync(ignoreHiddenConfigs, appConfigsDirPath?): string[]

Parameters

Name	Type
ignoreHiddenConfigs	boolean
appConfigsDirPath?	string

Returns

string[]

Defined in

@rnv/core/lib/configs/appConfigs.d.ts:1

---

loadDefaultConfigTemplates

▸ loadDefaultConfigTemplates(): Promise<undefined>

Returns

Promise<undefined>

Defined in

@rnv/core/lib/configs/index.d.ts:3

---

loadEnginePackageDeps

▸ loadEnginePackageDeps(engineConfigs): Promise<true | 0>

Parameters

Name	Type
engineConfigs	RnvEngineInstallConfig[]

Returns

Promise<true | 0>

Defined in

@rnv/core/lib/engines/index.d.ts:13

---

loadEnginePluginDeps

▸ loadEnginePluginDeps(engineConfigs): Promise<number>

Parameters

Name	Type
engineConfigs	RnvEngineInstallConfig[]

Returns

Promise<number>

Defined in

@rnv/core/lib/engines/index.d.ts:12

---

loadFile

▸ loadFile<T, K>(fileObj, pathObj, key): false | T[K]

Type parameters

Name	Type
T	T
K	extends string

Parameters

Name	Type
fileObj	T
pathObj	Partial<Record<K, unknown>>
key	K

Returns

false | T[K]

Defined in

@rnv/core/lib/system/fs.d.ts:47

---

loadFileExtended

▸ loadFileExtended(fileObj, pathObj, key): any

Parameters

Name	Type
fileObj	Record<string, any>
pathObj	RnvContextPathObj
key	RnvContextFileKey

Returns

any

Defined in

@rnv/core/lib/configs/index.d.ts:2

---

loadIntegrations

▸ loadIntegrations(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/integrations/index.d.ts:1

---

loadPluginTemplates

▸ loadPluginTemplates(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/plugins/index.d.ts:9

---

loadWorkspacesConfigSync

▸ loadWorkspacesConfigSync(): void

Returns

void

Defined in

@rnv/core/lib/configs/workspaces.d.ts:7

---

logAndSave

▸ logAndSave(msg, skipLog?): void

Parameters

Name	Type
msg	string
skipLog?	boolean

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:4

---

logAppInfo

▸ logAppInfo(c): void

Parameters

Name	Type
c	RnvContext

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:21

---

logDebug

▸ logDebug(...args): void

Parameters

Name	Type
...args	any[]

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:16

---

logDefault

▸ logDefault(task, customChalk?): void

Parameters

Name	Type
task	string
customChalk?	any

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:10

---

logError

▸ logError(e, opts?): void

Parameters

Name	Type
e	unknown
opts?	Object
opts.skipAnalytics	boolean

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:19

---

logExitTask

▸ logExitTask(task, customChalk?): void

Parameters

Name	Type
task	string
customChalk?	(s: string) => string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:12

---

logHook

▸ logHook(hook, msg?): void

Parameters

Name	Type
hook	string
msg?	string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:13

---

logInfo

▸ logInfo(msg): void

Parameters

Name	Type
msg	string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:15

---

logInitTask

▸ logInitTask(task, customChalk?): void

Parameters

Name	Type
task	string
customChalk?	string | (s: string) => string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:11

---

logInitialize

▸ logInitialize(): void

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:20

---

logRaw

▸ logRaw(...args): void

Parameters

Name	Type
...args	string[]

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:7

---

logSuccess

▸ logSuccess(msg): void

Parameters

Name	Type
msg	string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:18

---

logSummary

▸ logSummary(opts?): void

Parameters

Name	Type
opts?	Object
opts.header	string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:8

---

logTask

▸ logTask(task, customChalk?): void

Parameters

Name	Type
task	string
customChalk?	any

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:9

---

logToSummary

▸ logToSummary(v, sanitizePaths?): void

Parameters

Name	Type
v	string
sanitizePaths?	() => string

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:6

---

logWarning

▸ logWarning(msg): void

Parameters

Name	Type
msg	unknown

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:14

---

logWelcome

▸ logWelcome(): void

Returns

void

Defined in

@rnv/core/lib/logger/index.d.ts:3

---

mergeObjects

▸ mergeObjects<T1>(c, obj1, obj2, dynamicRefs?, replaceArrays?): T1

Type parameters

Name
T1

Parameters

Name	Type
c	RnvContext
obj1	Partial<T1>
obj2	Partial<T1>
dynamicRefs?	boolean
replaceArrays?	boolean

Returns

T1

Defined in

@rnv/core/lib/system/fs.d.ts:44

---

mkdirSync

▸ mkdirSync(dir): void

Parameters

Name	Type
dir	string

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:29

---

overrideFileContents

▸ overrideFileContents(dest, override, overridePath?): void

Parameters

Name	Type
dest	string
override	Record<string, string>
overridePath?	string

Returns

void

Defined in

@rnv/core/lib/plugins/index.d.ts:10

---

overrideTemplatePlugins

▸ overrideTemplatePlugins(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/plugins/index.d.ts:12

---

parseErrorMessage

▸ parseErrorMessage(text, maxErrorLength?): string

Parameters

Name	Type
text	string
maxErrorLength?	number

Returns

string

Defined in

@rnv/core/lib/system/exec.d.ts:42

---

parseFonts

▸ parseFonts(callback): void

Parameters

Name	Type
callback	ParseFontsCallback

Returns

void

Defined in

@rnv/core/lib/projects/fonts.d.ts:2

---

parsePlugins

▸ parsePlugins(pluginCallback, ignorePlatformObjectCheck?, includeDisabledOrExcludedPlugins?): void

Parameters

Name	Type
pluginCallback	PluginCallback
ignorePlatformObjectCheck?	boolean
includeDisabledOrExcludedPlugins?	boolean

Returns

void

Defined in

@rnv/core/lib/plugins/index.d.ts:8

---

parseRenativeConfigs

▸ parseRenativeConfigs(): Promise<undefined>

Returns

Promise<undefined>

Defined in

@rnv/core/lib/configs/index.d.ts:4

---

populateContextPaths

▸ populateContextPaths(c, RNV_HOME_DIR): void

Parameters

Name	Type
c	RnvContext
RNV_HOME_DIR	string

Returns

void

Defined in

@rnv/core/lib/context/index.d.ts:4

---

printArrIntoBox

▸ printArrIntoBox(arr, prefix?): string

Parameters

Name	Type
arr	string[]
prefix?	string

Returns

string

Defined in

@rnv/core/lib/logger/index.d.ts:23

---

printBoxEnd

▸ printBoxEnd(): string

Returns

string

Defined in

@rnv/core/lib/logger/index.d.ts:25

---

printBoxStart

▸ printBoxStart(str, str2?): string

Parameters

Name	Type
str	string
str2?	string

Returns

string

Defined in

@rnv/core/lib/logger/index.d.ts:24

---

printIntoBox

▸ printIntoBox(str): string

Parameters

Name	Type
str	string

Returns

string

Defined in

@rnv/core/lib/logger/index.d.ts:22

---

readCleanFile

▸ readCleanFile(source, overrides?): Buffer

Parameters

Name	Type
source	string
overrides?	OverridesOptions

Returns

Buffer

Defined in

@rnv/core/lib/system/fs.d.ts:22

---

readObjectSync

▸ readObjectSync<T>(filePath?, sanitize?, c?): T

Type parameters

Name	Type
T	object

Parameters

Name	Type
filePath?	string
sanitize?	boolean
c?	RnvContext

Returns

T

Defined in

@rnv/core/lib/system/fs.d.ts:37

---

registerAllPlatformEngines

▸ registerAllPlatformEngines(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/engines/index.d.ts:11

---

registerEngine

▸ registerEngine(engine, platform?, engConfig?): Promise<void>

Parameters

Name	Type
engine	RnvEngine
platform?	RnvPlatform
engConfig?	RnvEngineTemplate

Returns

Promise<void>

Defined in

@rnv/core/lib/engines/index.d.ts:6

---

registerEngineExtension

▸ registerEngineExtension(ext, eExt?, extras?): string[]

Parameters

Name	Type
ext	string
eExt?	string
extras?	string[]

Returns

string[]

Defined in

@rnv/core/lib/engines/index.d.ts:7

---

registerMissingPlatformEngines

▸ registerMissingPlatformEngines(taskInstance?): Promise<boolean>

Parameters

Name	Type
taskInstance?	RnvTask

Returns

Promise<boolean>

Defined in

@rnv/core/lib/engines/index.d.ts:10

---

registerPlatformEngine

▸ registerPlatformEngine(platform): Promise<void>

Parameters

Name	Type
platform	boolean | RnvPlatform

Returns

Promise<void>

Defined in

@rnv/core/lib/engines/index.d.ts:15

---

registerRnvTasks

▸ registerRnvTasks(tasks): Promise<void>

Parameters

Name	Type
tasks	RnvTaskMap

Returns

Promise<void>

Defined in

@rnv/core/lib/tasks/taskRegistry.d.ts:2

---

removeDir

▸ removeDir(pth, callback): void

Parameters

Name	Type
pth	string
callback	() => void

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:28

---

removeDirSync

▸ removeDirSync(_dir, _rmSelf?): void

Parameters

Name	Type
_dir	string
_rmSelf?	boolean

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:34

---

removeDirs

▸ removeDirs(dirPaths): Promise<void>

Parameters

Name	Type
dirPaths	string[]

Returns

Promise<void>

Defined in

@rnv/core/lib/system/fs.d.ts:33

---

removeDirsSync

▸ removeDirsSync(dirPaths): void

Parameters

Name	Type
dirPaths	string[]

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:32

---

removeFilesSync

▸ removeFilesSync(filePaths): void

Parameters

Name	Type
filePaths	string[]

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:31

---

replaceHomeFolder

▸ replaceHomeFolder(p): string

Parameters

Name	Type
p	string

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:45

---

resolveEngineDependencies

▸ resolveEngineDependencies(): Promise<void>

Returns

Promise<void>

Defined in

@rnv/core/lib/engines/dependencyResolver.d.ts:1

---

resolvePackage

▸ resolvePackage(text): string

Parameters

Name	Type
text	string

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:42

---

resolvePluginDependants

▸ resolvePluginDependants(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/plugins/index.d.ts:7

---

resolveRelativePackage

▸ resolveRelativePackage(c, v): string

Parameters

Name	Type
c	RnvContext
v	string

Returns

string

Defined in

@rnv/core/lib/projects/utils.d.ts:2

---

sanitizeDynamicProps

▸ sanitizeDynamicProps<T>(obj, propConfig): T

Type parameters

Name	Type
T	unknown

Parameters

Name	Type
obj	T
propConfig	FileUtilsPropConfig

Returns

T

Defined in

@rnv/core/lib/system/fs.d.ts:43

---

sanitizeDynamicRefs

▸ sanitizeDynamicRefs<T>(c, obj): T

Type parameters

Name	Type
T	unknown

Parameters

Name	Type
c	RnvContext
obj	T

Returns

T

Defined in

@rnv/core/lib/system/fs.d.ts:41

---

sanitizePluginPath

▸ sanitizePluginPath(str, name, mandatory?, options?): string

Parameters

Name	Type
str	string
name	string
mandatory?	boolean
options?	ResolveOptions

Returns

string

Defined in

@rnv/core/lib/plugins/index.d.ts:14

---

saveAsJs

▸ saveAsJs(source, dest): void

Parameters

Name	Type
source	string
dest	string

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:27

---

selectPlatformIfRequired

▸ selectPlatformIfRequired(knownTaskInstance?, registerEngineIfPlatformSelected?): Promise<void>

Parameters

Name	Type
knownTaskInstance?	RnvTask<string>
registerEngineIfPlatformSelected?	boolean

Returns

Promise<void>

Defined in

@rnv/core/lib/tasks/taskHelpers.d.ts:2

---

shouldSkipTask

▸ shouldSkipTask(«destructured»): boolean

Parameters

Name	Type
«destructured»	Object
› taskName	string

Returns

boolean

Defined in

@rnv/core/lib/tasks/taskHelpers.d.ts:9

---

updateObjectSync

▸ updateObjectSync(filePath, updateObj): object

Parameters

Name	Type
filePath	string
updateObj	object

Returns

object

Defined in

@rnv/core/lib/system/fs.d.ts:38

---

updatePackage

▸ updatePackage(override): void

Parameters

Name	Type
override	Partial<NpmPackageFile>

Returns

void

Defined in

@rnv/core/lib/projects/package.d.ts:2

---

updateProjectPlatforms

▸ updateProjectPlatforms(platforms): void

Parameters

Name	Type
platforms	("android" | "linux" | "web" | "ios" | "androidtv" | "firetv" | "tvos" | "macos" | "windows" | "tizen" | "webos" | "chromecast" | "kaios" | "webtv" | "androidwear" | "tizenwatch" | "tizenmobile" | "xbox")[]

Returns

void

Defined in

@rnv/core/lib/configs/configProject.d.ts:6

---

updateRenativeConfigs

▸ updateRenativeConfigs(): Promise<boolean>

Returns

Promise<boolean>

Defined in

@rnv/core/lib/plugins/index.d.ts:27

---

upgradeDependencies

▸ upgradeDependencies(packageFile, packagesPath, configFile, configPath, version): string[]

Parameters

Name	Type
packageFile	NpmPackageFile
packagesPath	string
configFile	ConfigFileProject
configPath	string
version	string

Returns

string[]

Defined in

@rnv/core/lib/configs/configProject.d.ts:5

---

upgradeProjectDependencies

▸ upgradeProjectDependencies(version): string[]

Parameters

Name	Type
version	string

Returns

string[]

Defined in

@rnv/core/lib/configs/configProject.d.ts:4

---

validateRenativeProjectSchema

▸ validateRenativeProjectSchema(inputJson): SafeParseReturnType<{ [x: string]: any; }, { [x: string]: any; }>

Parameters

Name	Type
inputJson	unknown

Returns

SafeParseReturnType<{ [x: string]: any; }, { [x: string]: any; }>

Defined in

@rnv/core/lib/schema/validators.d.ts:1

---

versionCheck

▸ versionCheck(c): Promise<boolean>

Parameters

Name	Type
c	RnvContext

Returns

Promise<boolean>

Defined in

@rnv/core/lib/projects/version.d.ts:2

---

waitForExecCLI

▸ waitForExecCLI(cli, command, callback): Promise<boolean>

Parameters

Name	Type
cli	string
command	string
callback	(resp: string | true) => boolean

Returns

Promise<boolean>

Defined in

@rnv/core/lib/system/exec.d.ts:46

---

writeCleanFile

▸ writeCleanFile(source, destination, overrides?, timestampPathsConfig?, c?): void

Parameters

Name	Type
source	string
destination	string
overrides?	OverridesOptions
timestampPathsConfig?	TimestampPathsConfig
c?	RnvContext

Returns

void

Defined in

@rnv/core/lib/system/fs.d.ts:21

---

writeFileSync

▸ writeFileSync(filePath, obj, spaces?, addNewLine?): string

Parameters

Name	Type
filePath	string
obj	string | object
spaces?	number
addNewLine?	boolean

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:35

---

writeObjectSync

▸ writeObjectSync(filePath, obj, spaces, addNewLine?): string

Parameters

Name	Type
filePath	string
obj	string | object
spaces	number
addNewLine?	boolean

Returns

string

Defined in

@rnv/core/lib/system/fs.d.ts:36

---

writeRenativeConfigFile

▸ writeRenativeConfigFile(configPath, configData): void

Parameters

Name	Type
configPath	string
configData	string | object

Returns

void

Defined in

@rnv/core/lib/configs/utils.d.ts:1