Class Pakaje

Service to save or load package.json config file

Hierarchy

Pakaje

Index

Constructors

Methods

load loadSync new save saveSync

Constructors

constructor

new Pakaje(): Pakaje
Returns Pakaje

Methods

`Static` load

load(path?): Promise<PackageJson>
Loads a package.json config. If no path given, loads the current project(*'s config)

Returns
A promise containing the loaded config
Parameters
- path: string = defaultPackagePath
  
  The saving path
Returns Promise<PackageJson>
- Defined in Pakaje.ts:51

`Static` loadSync

loadSync(path?): PackageJson
Loads a package.json config. If no path given, loads the current project(*'s config)

Returns
The loaded config
Parameters
- path: string = defaultPackagePath
  
  The saving path
Returns PackageJson
- Defined in Pakaje.ts:64

`Static` new

new(appName): PackageJson
Returns
A default package.json template.
Parameters
- appName: string
  
  The app name of the project.
Returns PackageJson
- Defined in Pakaje.ts:17

`Static` save

save(config, path?): Promise<void>
Writes the given model in a "package.json" file
Parameters
- config: PackageJson
  
  The PackageJson model.
- path: string = defaultPackagePath
  
  The saving path
Returns Promise<void>
- Defined in Pakaje.ts:37

`Static` saveSync

saveSync(config, path?): void
Writes the given model in a "package.json" file
Parameters
- config: PackageJson
  
  The PackageJson model.
- path: string = defaultPackagePath
  
  The saving path
Returns void
- Defined in Pakaje.ts:44

Generated using TypeDoc