2018-07-03 06:59:00 +00:00
|
|
|
# @pushrocks/smartfile
|
2019-04-08 14:39:41 +00:00
|
|
|
smart ways to work with files in nodejs
|
2018-07-03 06:55:09 +00:00
|
|
|
|
2019-04-08 14:39:41 +00:00
|
|
|
## Availabililty and Links
|
|
|
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartfile)
|
|
|
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartfile)
|
|
|
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartfile)
|
|
|
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartfile/)
|
2016-09-18 18:09:17 +00:00
|
|
|
|
|
|
|
|
## Status for master
|
2016-06-23 17:02:34 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
2016-09-18 18:09:17 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartfile/commits/master)
|
2019-04-08 14:39:41 +00:00
|
|
|
[](https://www.npmjs.com/package/@pushrocks/smartfile)
|
|
|
|
|
[](https://snyk.io/test/npm/@pushrocks/smartfile)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://prettier.io/)
|
2016-03-14 02:50:14 +00:00
|
|
|
|
2016-06-23 17:02:34 +00:00
|
|
|
## Usage
|
2018-07-03 06:55:09 +00:00
|
|
|
|
2016-06-23 17:02:34 +00:00
|
|
|
smartfile is an approach of being one tool to handle files in diverse environments.
|
2016-09-18 18:09:17 +00:00
|
|
|
|
|
|
|
|
### Smartfile Sections
|
2018-07-03 06:55:09 +00:00
|
|
|
|
2016-09-18 18:09:17 +00:00
|
|
|
smartfile thinks in sections:
|
|
|
|
|
|
2018-07-03 06:55:09 +00:00
|
|
|
| section | description |
|
|
|
|
|
| ----------- | ---------------------------------------------------------------------------- |
|
|
|
|
|
| fs | (object) gets data from fs to somewhere |
|
|
|
|
|
| memory | gets data from memory to somewhere |
|
|
|
|
|
| remote | gets data from remote locations to somewhere |
|
|
|
|
|
| interpreter | (object) handles yaml and json |
|
|
|
|
|
| smartfile | (class) a virtual representation of a file, alternative to vinyl file format |
|
2016-09-18 18:09:17 +00:00
|
|
|
|
2019-04-08 14:39:41 +00:00
|
|
|
For further information read the linked docs at the top of this readme.
|
2017-02-03 14:14:30 +00:00
|
|
|
|
2017-02-23 00:03:21 +00:00
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
2019-04-08 14:39:41 +00:00
|
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
2016-09-18 18:09:17 +00:00
|
|
|
|
2019-04-08 14:39:41 +00:00
|
|
|
[](https://maintainedby.lossless.com)
|
