vnfmarket/src/main/webapp/vnfmarket/node_modules/base64-url/README.md

   1 # base64-url
   2
   3 Base64 encode, decode, escape and unescape for URL applications.
   4
   5 <a href="https://nodei.co/npm/base64-url/"><img src="https://nodei.co/npm/base64-url.png?downloads=true"></a>
   6
   7 [![Build Status](https://travis-ci.org/joaquimserafim/base64-url.png?branch=master)](https://travis-ci.org/joaquimserafim/base64-url)
   8
   9
  10 ## API
  11
  12 ```js
  13 var base64url = require('base64-url');
  14
  15 base64url.encode('Node.js is awesome.');
  16 // returns Tm9kZS5qcyBpcyBhd2Vzb21lLg
  17
  18 base64url.decode('Tm9kZS5qcyBpcyBhd2Vzb21lLg');
  19 // returns Node.js is awesome.
  20
  21 base64url.escape('This+is/goingto+escape==');
  22 // returns This-is_goingto-escape
  23
  24 base64url.unescape('This-is_goingto-escape');
  25 // returns This+is/goingto+escape==
  26 ```
  27
  28
  29 ## Development
  30
  31 **this project has been set up with a precommit that forces you to follow a code style, no jshint issues and 100% of code coverage before commit**
  32
  33
  34 to run test
  35 ``` js
  36 npm test
  37 ```
  38
  39 to run lint
  40 ``` js
  41 npm run lint
  42 ```
  43
  44 to run code style
  45 ``` js
  46 npm run style
  47 ```
  48
  49 to check code coverage
  50 ``` js
  51 npm run coverage:check
  52 ```