50 lines
2.6 KiB
Markdown
50 lines
2.6 KiB
Markdown
|
# @pushrocks/smartarchive
|
||
|
|
work with archives
|
||
|
|
|
||
|
|
## Availabililty and Links
|
||
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartarchive)
|
||
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartarchive)
|
||
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartarchive)
|
||
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartarchive/)
|
||
|
|
|
||
|
|
## Status for master
|
||
|
|
[](https://gitlab.com/pushrocks/smartarchive/commits/master)
|
||
|
|
[](https://gitlab.com/pushrocks/smartarchive/commits/master)
|
||
|
|
[](https://www.npmjs.com/package/@pushrocks/smartarchive)
|
||
|
|
[](https://snyk.io/test/npm/@pushrocks/smartarchive)
|
||
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||
|
|
[](https://prettier.io/)
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Use TypeScript for best in class instellisense.
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import * as smartarchive from 'smartarchive';
|
||
|
|
smartarchive
|
||
|
|
.get({
|
||
|
|
from: 'https://example.com/example.zip',
|
||
|
|
toPath: '/some/local/absolute/path'
|
||
|
|
})
|
||
|
|
.then(/*...*/);
|
||
|
|
```
|
||
|
|
|
||
|
|
For further information read the linked docs at the top of this README.
|
||
|
|
|
||
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||
|
|
> | By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
||
|
|
|
||
|
|
[](https://push.rocks)
|
||
|
|
|
||
|
|
## Contribution
|
||
|
|
|
||
|
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||
|
|
|
||
|
|
For further information read the linked docs at the top of this readme.
|
||
|
|
|
||
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||
|
|
|
||
|
|
[](https://maintainedby.lossless.com)
|