Struct npm_rs::NpmEnv

pub struct NpmEnv(_);

This struct is used to create the enviroment in which npm will execute commands. NpmEnv uses Command so it takes all the env variables in your system.

After the environment is configured, use NpmEnv::init() to start issuing commands to Npm.

Example

use npm_rs::*;

let npm = NpmEnv::default()
                 .with_env("NODE_ENV", "production")
                 .init();

Implementations

impl NpmEnv

pub fn with_env<K, V>(self, key: K, val: V) -> Self where
    K: AsRef<OsStr>,
    V: AsRef<OsStr>, 

Inserts or updates a enviroment variable mapping.

pub fn with_envs<I, K, V>(self, vars: I) -> Self where
    I: IntoIterator<Item = (K, V)>,
    K: AsRef<OsStr>,
    V: AsRef<OsStr>, 

Inserts or updates multiple environment variable mappings.

pub fn clear_envs(self) -> Self

Clears the entire environment map for Npm.

pub fn remove_env<K>(self, key: K) -> Self where
    K: AsRef<OsStr>, 

Removes an enviroment variable mapping.

pub fn set_path<P>(self, path: P) -> Self where
    P: AsRef<Path>, 

Sets the working directory for Npm.

pub fn init(self) -> Npm

Initilizes Npm with the configured environment.

This method will be NpmEnv::init(&self) when Command derives Clone.

Trait Implementations

impl Default for NpmEnv

fn default() -> Self

Returns the “default value” for a type.