Skip to content
packagespackage-jsonreference

@vltpkg/package-json

Classes

PackageJson

Defined in: index.ts:24

Constructors

new PackageJson()
new PackageJson(): PackageJson
Returns

PackageJson

Methods

find()
find(cwd, home): undefined | string

Defined in: index.ts:166

Walks up the directory tree from the current working directory and returns the path to the first package.json file found. Returns undefined if no package.json is found.

Parameters
cwd

string = ...

home

string = ...

Returns

undefined | string

fix()
fix(manifest): void

Defined in: index.ts:147

Parameters
manifest

Override

Returns

void

maybeRead()
maybeRead(dir, __namedParameters):
  | undefined
| Override<Manifest, NormalizedFields>

Defined in: index.ts:89

Optionally reads and parses contents of a package.json file at a directory dir. Returns undefined if it could not be read.

Parameters
dir

string

__namedParameters
reload?

boolean

Returns

| undefined | Override<Manifest, NormalizedFields>

read()
read(dir, __namedParameters): Override

Defined in: index.ts:44

Reads and parses contents of a package.json file at a directory dir. reload will optionally skip reading from the cache when set to true.

Parameters
dir

string

__namedParameters
reload?

boolean

Returns

Override

save()
save(manifest): void

Defined in: index.ts:133

Parameters
manifest

Override

Returns

void

write()
write(
   dir,
   manifest,
   indent?): void

Defined in: index.ts:100

Parameters
dir

string

manifest

Override

indent?

number

Returns

void