Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/herber/hashicle-from-file
Generate hashes from files
https://github.com/herber/hashicle-from-file
Last synced: 3 days ago
JSON representation
Generate hashes from files
- Host: GitHub
- URL: https://github.com/herber/hashicle-from-file
- Owner: herber
- License: mit
- Created: 2017-09-03T13:13:40.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2017-10-05T05:57:27.000Z (almost 7 years ago)
- Last Synced: 2024-09-04T09:46:45.523Z (24 days ago)
- Language: JavaScript
- Size: 36.1 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# hashicle-from-file [![Codestyle fyi](https://img.shields.io/badge/code%20style-fyi-E91E63.svg)](https://github.com/tobihrbr/fyi) [![Build Status](https://travis-ci.org/herber/hashicle-from-file.svg?branch=master)](https://travis-ci.org/herber/hashicle-from-file) [![Coverage Status](https://coveralls.io/repos/github/tobihrbr/hashicle-from-file/badge.svg?branch=master)](https://coveralls.io/github/tobihrbr/hashicle-from-file?branch=master)
> Generate hashes from files
## Install
```
$ npm install --save hashicle-from-file
```## Usage
```js
const hashicle = require('hashicle-from-file');hashicle('my-file.ext').then((hash) => {
// do something
});
```## API
### hashicle(path, [algorithm, out])
#### path
Type: `string`
Your files path
#### algorithm
Type: `string`
Default: `md5`Hashing algorithm
#### out
Type: `string`
Default: `hex`Output format
## License
MIT © [Tobias Herber](https://tobihrbr.com)