Skip to content

editPackageJson

Reads, edits, and writes back the package.json file using the provided edit function.

Import:

import { editPackageJson } from '@mnaoumov/typescript-dev-toolkit/npm';

Signature:

function editPackageJson(editFunction: (packageJson: PackageJson) => Promisable<void>, options: EditPackageJsonOptions): Promise<void>

Parameters:

Parameter Type Description
editFunction (packageJson: PackageJson) => Promisable<void> The function to edit the parsed PackageJson object.
options EditPackageJsonOptions Additional options for editing.

Returns: Promise<void> — A Promise that resolves when the file has been edited and written.


Links to this page: