2.1.0 • Published 5 years ago
@panda-clouds/parse-bash v2.1.0
PCBash
maintained by PandaClouds.com
PCBash
is a lightweight JavaScript library for Node.js that provides additional Bash methods.
Installation
If you want to use this library, you first need to install the Node.js.
When you install node.js, will also be installed npm.
Please run the following command.
npm install --save @panda-clouds/parse-bash
Usage
Node.js
const PCBash = require('@panda-clouds/parse-bash');
// example usage
PCBash.runCommandPromise('pwd')
.then((result)=>{
console.log(result) // => "/path/to/my/dir";
});
PCBash.putStringInFile('Hello World!',"/tmp/hello-world")
.then((result)=>{
PCBash.runCommandPromise('cat "/tmp/hello-world"')
.then((result)=>{
console.log(result) // => "Hello World!";
});
});
You can replace PCBash with any variable.
Methods
Unit Tests are an additional resource for learning functionality.
- runCommandPromise(string)
Returns a promise that is resolved with the contents of stdout.
Example:
PCBash.runCommandPromise('pwd')
.then((result)=>{
console.log(result) // => "/path/to/my/dir";
});
- putStringInFile(string)
places the contents of the string into the file path provided
Example:
PCBash.putStringInFile('Hello World!',"/tmp/hello-world")
.then((result)=>{
PCBash.runCommandPromise('cat "/tmp/hello-world"')
.then((result)=>{
console.log(result) // => "Hello World!";
});
});
Contributions
Pull requests are welcome! here is a checklist to speed things up:
- modify
PCBash.js
- add unit tests in
PCBash.spec.js
- run
npm test
- document method in
README.md
- add your name to 'Contributors' in
README.md
Contributors
(Add your name)