Struct PackageJson 

pub struct PackageJson {
    pub path: PathBuf,
    pub realpath: PathBuf,
    /* private fields */
}

Serde implementation for the deserialized package.json.

This implementation is used by the crate::Cache and enabled through the fs_cache feature.

Fields

path: PathBuf

Path to package.json. Contains the package.json filename.

realpath: PathBuf

Realpath to package.json. Contains the package.json filename.

Implementations

impl PackageJson

pub fn path(&self) -> &Path

Returns the path where the package.json was found.

Contains the package.json filename.

This does not need to be the path where the file is stored on disk. See Self::realpath().

pub fn realpath(&self) -> &Path

Returns the path where the package.json file was stored on disk.

Contains the package.json filename.

This is the canonicalized version of Self::path(), where all symbolic links are resolved.

pub fn directory(&self) -> &Path

Directory to package.json.

Panics

• When the package.json path is misconfigured.

pub fn name(&self) -> Option<&str>

Name of the package.

The “name” field can be used together with the “exports” field to self-reference a package using its name.

https://nodejs.org/api/packages.html#name

pub fn version(&self) -> Option<&str>

Version of the package.

https://nodejs.org/api/packages.html#name

pub fn type(&self) -> Option<PackageType>

Returns the package type, if one is configured in the package.json.

https://nodejs.org/api/packages.html#type

pub fn side_effects(&self) -> Option<SideEffects<'_>>

The “sideEffects” field.

https://webpack.js.org/guides/tree-shaking

pub fn exports(&self) -> Option<ImportsExportsEntry<'_>>

The “exports” field allows defining the entry points of a package.

https://nodejs.org/api/packages.html#exports

pub fn parse<Fs: FileSystem>( fs: &Fs, path: PathBuf, realpath: PathBuf, json: Vec<u8>, ) -> Result<Self, JSONError>

Parse a package.json file from JSON bytes

Panics

Errors

Trait Implementations

impl Debug for PackageJson

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.