<!DOCTYPE html>
< html lang = "en" >
< head >
< meta charset = "utf-8" >
< title > JSDoc: Namespace: md5< / title >
< script src = "scripts/prettify/prettify.js" > < / script >
< script src = "scripts/prettify/lang-css.js" > < / script >
<!-- [if lt IE 9]>
< script src = "//html5shiv.googlecode.com/svn/trunk/html5.js" > < / script >
<![endif]-->
< link type = "text/css" rel = "stylesheet" href = "styles/prettify-tomorrow.css" >
< link type = "text/css" rel = "stylesheet" href = "styles/jsdoc-default.css" >
< / head >
< body >
< div id = "main" >
< h1 class = "page-title" > Namespace: md5< / h1 >
< section >
< header >
< h2 > md5< / h2 >
< / header >
< article >
< div class = "container-overview" >
< div class = "description" > < a href = "https://github.com/emn178/js-md5" > js-md5< / a > < / div >
< dl class = "details" >
< dt class = "tag-version" > Version:< / dt >
< dd class = "tag-version" > < ul class = "dummy" > < li > 0.4.0< / li > < / ul > < / dd >
< dt class = "tag-author" > Author:< / dt >
< dd class = "tag-author" >
< ul >
< li > Chen, Yi-Cyuan [emn178@gmail.com]< / li >
< / ul >
< / dd >
< dt class = "tag-copyright" > Copyright:< / dt >
< dd class = "tag-copyright" > < ul class = "dummy" > < li > Chen, Yi-Cyuan 2014-2016< / li > < / ul > < / dd >
< dt class = "tag-license" > License:< / dt >
< dd class = "tag-license" > < ul class = "dummy" > < li > MIT< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line1" > line 1< / a >
< / li > < / ul > < / dd >
< / dl >
< / div >
< h3 class = "subsection-title" > Methods< / h3 >
< h4 class = "name" id = ".array" > < span class = "type-signature" > (static) < / span > array< span class = "signature" > (message)< / span > < span class = "type-signature" > → {Array}< / span > < / h4 >
< div class = "description" >
Output hash as bytes array
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line52" > line 52< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Bytes array
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array< / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > md5.array('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< h4 class = "name" id = ".arrayBuffer" > < span class = "type-signature" > (static) < / span > arrayBuffer< span class = "signature" > (message)< / span > < span class = "type-signature" > → {ArrayBuffer}< / span > < / h4 >
< div class = "description" >
Output hash as ArrayBuffer
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line61" > line 61< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
ArrayBuffer
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > ArrayBuffer< / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > md5.arrayBuffer('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< h4 class = "name" id = ".buffer" > < span class = "type-signature" > (static) < / span > buffer< span class = "signature" > (message)< / span > < span class = "type-signature" > → {ArrayBuffer}< / span > < / h4 >
< div class = "description" >
Output hash as ArrayBuffer
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "important tag-deprecated" > Deprecated:< / dt > < dd > < ul class = "dummy" > < li > This maybe confuse with Buffer in node.js. Please use arrayBuffer instead.< / li > < / ul > < / dd >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line70" > line 70< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
ArrayBuffer
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > ArrayBuffer< / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > md5.buffer('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< h4 class = "name" id = ".create" > < span class = "type-signature" > (static) < / span > create< span class = "signature" > ()< / span > < span class = "type-signature" > → {< a href = "Md5_.html" > Md5< / a > }< / span > < / h4 >
< div class = "description" >
Create Md5 object
< / div >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line86" > line 86< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Md5 object.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Md5_.html" > Md5< / a > < / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > var hash = md5.create();< / code > < / pre >
< h4 class = "name" id = ".digest" > < span class = "type-signature" > (static) < / span > digest< span class = "signature" > (message)< / span > < span class = "type-signature" > → {Array}< / span > < / h4 >
< div class = "description" >
Output hash as bytes array
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line43" > line 43< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Bytes array
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > Array< / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > md5.digest('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< h4 class = "name" id = ".hex" > < span class = "type-signature" > (static) < / span > hex< span class = "signature" > (message)< / span > < span class = "type-signature" > → {String}< / span > < / h4 >
< div class = "description" >
Output hash as hex string
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line32" > line 32< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Hex string
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > String< / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > md5.hex('The quick brown fox jumps over the lazy dog');
// equal to
md5('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< h4 class = "name" id = ".update" > < span class = "type-signature" > (static) < / span > update< span class = "signature" > (message)< / span > < span class = "type-signature" > → {< a href = "Md5_.html" > Md5< / a > }< / span > < / h4 >
< div class = "description" >
Create and update Md5 object
< / div >
< h5 > Parameters:< / h5 >
< table class = "params" >
< thead >
< tr >
< th > Name< / th >
< th > Type< / th >
< th class = "last" > Description< / th >
< / tr >
< / thead >
< tbody >
< tr >
< td class = "name" > < code > message< / code > < / td >
< td class = "type" >
< span class = "param-type" > String< / span >
|
< span class = "param-type" > Array< / span >
|
< span class = "param-type" > Uint8Array< / span >
|
< span class = "param-type" > ArrayBuffer< / span >
< / td >
< td class = "description last" > message to hash< / td >
< / tr >
< / tbody >
< / table >
< dl class = "details" >
< dt class = "tag-source" > Source:< / dt >
< dd class = "tag-source" > < ul class = "dummy" > < li >
< a href = "md5.js.html" > md5.js< / a > , < a href = "md5.js.html#line94" > line 94< / a >
< / li > < / ul > < / dd >
< / dl >
< h5 > Returns:< / h5 >
< div class = "param-desc" >
Md5 object.
< / div >
< dl >
< dt >
Type
< / dt >
< dd >
< span class = "param-type" > < a href = "Md5_.html" > Md5< / a > < / span >
< / dd >
< / dl >
< h5 > Example< / h5 >
< pre class = "prettyprint" > < code > var hash = md5.update('The quick brown fox jumps over the lazy dog');
// equal to
var hash = md5.create();
hash.update('The quick brown fox jumps over the lazy dog');< / code > < / pre >
< / article >
< / section >
< / div >
< nav >
< h2 > < a href = "index.html" > Home< / a > < / h2 > < h3 > Classes< / h3 > < ul > < li > < a href = "Md5_.html" > Md5< / a > < / li > < / ul > < h3 > Namespaces< / h3 > < ul > < li > < a href = "md5.html" > md5< / a > < / li > < / ul > < h3 > Global< / h3 > < ul > < li > < a href = "global.html#md5%2508" > md5< / a > < / li > < / ul >
< / nav >
< br class = "clear" >
< footer >
Documentation generated by < a href = "https://github.com/jsdoc3/jsdoc" > JSDoc 3.4.0< / a > on Thu Mar 31 2016 16:24:21 GMT+0800 (CST)
< / footer >
< script > prettyPrint ( ) ; < / script >
< script src = "scripts/linenumber.js" > < / script >
< / body >
< / html >
