Skip to main content


@rnx-kit/tools-node is a collection of supplemental NodeJS functions and types.

You can import the entire package, or, to save space, import individual categories:

import * from "@rnx-kit/tools-node";

import * from "@rnx-kit/tools-node/fs";
import * from "@rnx-kit/tools-node/module";
import * from "@rnx-kit/tools-node/package";
import * from "@rnx-kit/tools-node/path";
CategoryType NameDescription
moduleFileModuleRefModule reference rooted to a file system location, either relative to a directory, or as an absolute path. For example, ./index or /repos/rnx-kit/packages/tools/src/index.
modulePackageModuleRefModule reference relative to a package, such as react-native or @rnx-kit/tools/node/index.
packageFindPackageDependencyOptionsOptions which control how package dependecies are located.
packagePackageManifestSchema for the contents of a package.json manifest file.
packagePackagePersonSchema for a reference to a person in package.json.
packagePackageRefComponents of a package reference.
fscreateDirectory(p)Create a directory, and all missing parent directories.
fsfindFirstFileExists(rootDir, ...relativeFiles)Combine the root directory with each relative file, testing whether or not the file exists. Stop and return as soon as a file is found.
fsisDirectory(p)Determine if the target path refers to a directory.
fsisFile(p)Determine if the target path refers to a file.
fsstatSync(p)Get stats (detailed information) for the target path.
modulegetPackageModuleRefFromModulePath(modulePath)Convert a module path to a package module reference.
moduleisFileModuleRef(r)Is the module reference relative to a file location?
moduleisPackageModuleRef(r)Is the module reference a package module reference?
moduleparseModuleRef(r)Parse a module reference into either a package module reference or a file module reference.
packagefindPackage(startDir)Find the nearest package.json manifest file. Search upward through all parent directories.
packagefindPackageDependencyDir(ref, options)Find the package dependency's directory, starting from the given directory and moving outward, through all parent directories.
packagefindPackageDir(startDir)Find the parent directory of the nearest package.json manifest file. Search upward through all parent directories.
packagegetMangledPackageName(ref)Get the mangled name for a package reference.
packageisPackageManifest(manifest)Determine if the given object is a package.json manifest.
packageparsePackageRef(r)Parse a package reference string. An example reference is the name property found in package.json.
packagereadPackage(pkgPath)Read a package.json manifest from a file.
packagewritePackage(pkgPath, manifest, space)Write a package.json manifest to a file.
pathescapePath(p)Escape a path by replacing each backslash ('\') with a double-backslash ("\\").
pathnormalizePath(p)Normalize the separators in a path, converting each backslash ('\') to a foreward slash ('/').