You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
81 lines
1.5 KiB
Markdown
81 lines
1.5 KiB
Markdown
# js-sha1
|
|
A simple SHA1 hash function for JavaScript supports UTF-8 encoding.
|
|
|
|
## Install
|
|
For node.js, you can use this command to install:
|
|
|
|
npm install js-sha1
|
|
|
|
## Usage
|
|
If you use node.js, you should require the module first:
|
|
```JavaScript
|
|
sha1 = require('js-sha1');
|
|
```
|
|
And you could use like this:
|
|
```JavaScript
|
|
sha1('Message to hash');
|
|
```
|
|
## Example
|
|
Code
|
|
```JavaScript
|
|
sha1('');
|
|
sha1('The quick brown fox jumps over the lazy dog');
|
|
sha1('The quick brown fox jumps over the lazy dog.');
|
|
```
|
|
Output
|
|
|
|
da39a3ee5e6b4b0d3255bfef95601890afd80709
|
|
2fd4e1c67a2d28fced849ee1bb76e7391b93eb12
|
|
408d94384216f890ff7a0c3528e8bed1e0b01621
|
|
|
|
It also supports UTF-8 encoding:
|
|
|
|
Code
|
|
```JavaScript
|
|
sha1('中文');
|
|
```
|
|
Output
|
|
|
|
7be2d2d20c106eee0836c9bc2b939890a78e8fb3
|
|
|
|
## Tests
|
|
You can open `tests/index.html` in browser or use node.js to run test
|
|
|
|
node tests/node-test.js
|
|
|
|
or
|
|
|
|
npm test
|
|
|
|
## Extensions
|
|
### jQuery
|
|
If you prefer jQuery style, you can add following code to add a jQuery extension.
|
|
|
|
Code
|
|
```JavaScript
|
|
jQuery.sha1 = sha1
|
|
```
|
|
And then you could use like this:
|
|
```JavaScript
|
|
$.sha1('message');
|
|
```
|
|
### Prototype
|
|
If you prefer prototype style, you can add following code to add a prototype extension.
|
|
|
|
Code
|
|
```JavaScript
|
|
String.prototype.sha1 = function() {
|
|
return sha1(this);
|
|
};
|
|
```
|
|
And then you could use like this:
|
|
```JavaScript
|
|
'message'.sha1();
|
|
```
|
|
## License
|
|
The project is released under the [MIT license](http://www.opensource.org/licenses/MIT).
|
|
|
|
## Contact
|
|
The project's website is located at https://github.com/emn178/js-sha1
|
|
Author: emn178@gmail.com
|