url-hash

1.0.2 • Public • Published

url-hash

Node library to add hash parameter for tamper-free urls

Basic Usage

Add hash to url

 
// require library
var urlHash = require('url-hash');
 
var url = 'http://www.example.com/page?id=4';
 
// add hash to url
var newUrl = urlHash.create(url);
 

Verify Url

 
// require library
var urlHash = require('url-hash');
 
// check integrity of url
var result = urlHash.check(url/to/verify);
 
/*
 
  result will either:
  1. equal true if the url is unchanged
  2. equal false if the url has been changed
 
*/

Configuration options

This library currently offers the following configuration options:

  • salt
  • expire
  • hash key name
 
urlHash.config({
                salt:    'someUniqueCustomSalt', // use custom salt (recommended)
                expire:  60000,                  // url expires after 1 minute
                hashKey: 'myCustomHashKeyName'   // use custom name for hash parameter
              });
 

Package Sidebar

Install

npm i url-hash

Weekly Downloads

75

Version

1.0.2

License

MIT

Last publish

Collaborators

  • jonathanprince