runas-core
Version:
The adhesive orchestrator
74 lines (50 loc) • 1.73 kB
Markdown
# fsUtils plugin
Some file I/O addons are provided:
1. [fsCreateDir() addon](#fsCreateDir)
1. [fsExists() addon](#fsExists)
1. [fsReadConfig() addon](#fsReadConfig)
1. [fsReadFile() addon](#fsReadFile)
## <a name="fsCreateDir"></a>1. fsCreateDir() addon
`this.fsCreateDir(dirName)` attempts to create synchronously a directory named `dirName`.
| Param | Type | Optional | Description |
| --- | --- | --- | --- |
| dir | String | No | name of the directory to crate |
Example:
```javascript
run: function() {
this.fsCreate('test');
}
```
## <a name="fsExists"></a>2. fsExists() addon
`this.fsExists(filename)` check synchronously if a element named `filename` exists and returns a boolean.
| Param | Type | Optional | Description |
| --- | --- | --- | --- |
| filename | String | No | name of the element to test is exists |
Example:
```javascript
run: function() {
let exist = this.fsExists('sample');
}
```
## <a name="fsReadConfig"></a>3. fsReadConfig() addon
`this.fsReadConfig(filename)` attemps to read synchronously a JSON file named `filename` exists, and returns an object with the `json`.
| Param | Type | Optional | Description |
| --- | --- | --- | --- |
| filename | String | No | name of the json file |
Example:
```javascript
run: function() {
let json = this.fsReadConfig('sample.json')
}
```
## <a name="fsReadFile"></a>4. fsReadFile() addon
`this.fsReadFile(filename)` attemps to read synchronously a text file named `filename` exists, and returns a string with the contain.
| Param | Type | Optional | Description |
| --- | --- | --- | --- |
| filename | String | No | name of the file |
Example:
```javascript
run: function() {
let contain = this.fsReadConfig('sample.json')
}
```