https://github.com/cuarti/zenox-rcfile
Read variables from rc files
https://github.com/cuarti/zenox-rcfile
config file javascript nodejs rc-files typescript zenox zenox-framework
Last synced: about 2 months ago
JSON representation
Read variables from rc files
- Host: GitHub
- URL: https://github.com/cuarti/zenox-rcfile
- Owner: cuarti
- License: mit
- Created: 2017-03-11T01:28:33.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-07-20T18:49:54.000Z (almost 9 years ago)
- Last Synced: 2026-05-03T12:37:13.806Z (about 2 months ago)
- Topics: config, file, javascript, nodejs, rc-files, typescript, zenox, zenox-framework
- Language: TypeScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
@zenox/rcfile
==
[](https://travis-ci.org/cuarti/zenox-rcfile)
[](https://www.npmjs.com/package/@zenox/rcfile)
[](https://github.com/cuarti/zenox-rcfile/blob/master/LICENSE)
## Description
NodeJS library builded in typescript to load data from file in bash format. It is part of Zenox Framework.
#### File example
```bash
# Comment
NAME=rcfile
VERSION=1
WORKS=true
```
## Installation
The usage of the module not depend of Zenox framework and can use it in your NodeJS program.
```bash
npm install --save @zenox/rcfile
```
## Documentation
*All the examples are in ES6/ES2015 of Javascript and Typescript.
To use all the features of Typescript, you can use the generic param
on load function.*
### load
Parse and load data from file.
#### Typescript definition
```typescript
declare function load(path: string, encoding: string = 'utf8'): Promise
```
#### Example
```typescript
import {load} from '@zenox/rcfile';
load('.examplerc').then(data => {
// ...
});
```
### RCFile
Object representation of file to load.
When resolve or resolvePath functions are called, it gets the real path of given
canonical path. It checks in order from:
- Absolute path.
- Current working directory path.
- Parents of current working directory path until file system root.
#### Typescript definition
```typescript
declare class RCFile {
public constructor(path: string, encoding: string = 'utf8');
public exists(): Promise;
public load(): Promise;
public static resolve(filename: string, encoding?: string): Promise;
public static resolvePath(filename: string): Promise;
}
```
#### RCFile#exists
Check if file exists.
#### RCFile#load
Parse and load data from file.
#### RCFile.resolve
Get existent RCFile object from canonical path
#### RCFile.resolvePath
Get existent path from canonical path
#### Example
```typescript
import {RCFile} from '@zenox/rcfile';
let file = new RCFile('.examplerc');
file.exists().then(exists => {
// ...
});
file.load().then(data => {
// ...
});
RCFile.resolve('.examplerc').then(file => {
// ...
});
RCFile.resolvePath('.examplerc').then(path => {
// ...
});
```
## License
The source code of the current repository are launched with MIT License.