ember-introjs
Version:
An Ember Component for intro.js
61 lines (45 loc) • 1.55 kB
Markdown
# sri-toolbox [](https://travis-ci.org/neftaly/npm-sri-toolbox) [](https://coveralls.io/r/neftaly/npm-sri-toolbox?branch=master)
[Subresource Integrity](http://www.w3.org/TR/SRI/) tools.
**SemVer note:** As the SRI spec has not yet been finalized, minor releases < 1.0.0 will contain breaking changes.
Install
-------
```shell
npm install sri-toolbox
```
Usage
-----
```js
var sriToolbox = require("sri-toolbox");
var jquerySourceCode = file("jquery-1.10.2.min.js");
var integrity = sriToolbox.generate({
algorithms: ["sha256"]
}, jquerySourceCode);
//=> "sha256-C6CB9UYIS9UJeqinPHWTHVqh/E1uhG5Twh+Y5qFQmYg="
```
You may also access the data used to build the integrity attribute, using the option "full":
```js
var integrityObject = sriToolbox.generate({
full: true
}, jquerySourceCode);
//=> object
```
```json
{
"hashes": {
"sha256": "C6CB9UYIS9UJeqinPHWTHVqh/E1uhG5Twh+Y5qFQmYg="
},
"integrity": "sha256-C6CB9UYIS9UJeqinPHWTHVqh/E1uhG5Twh+Y5qFQmYg="
}
```
API
-------
### generate
Generate creates a Sub-resource Integrity attribute from a data string.
#### Options
Key: type **name** *= default*
* array **algorithms** *= ["sha256"]*
List of hashing algorithms
* string **delimiter** *= " "*
Integrity attribute delimiter
* boolean **full** *= false*
Return a string if false, object if true. See example.