doc/HmacMd5.html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Class: HmacMd5</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">Class: HmacMd5</h1>

    
<section>

<header>
    
        <h2><span class="attribs"><span class="type-signature"></span></span>HmacMd5<span class="signature">()</span><span class="type-signature"></span></h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
    <h4 class="name" id="HmacMd5"><span class="type-signature"></span>new HmacMd5<span class="signature">()</span><span class="type-signature"></span></h4>
    

<div class="description">
    This is internal class.
</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#line779">line 779</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5.hmac.html#.create">md5.hmac.create</a></li>
        </ul>
    </dd>
    

</dl>


    </div>

    
        <h3 class="subsection-title">Extends</h3>

        
    <ul>
        <li><a href="Md5.html">Md5</a></li>
    </ul>


        <h3 class="subsection-title">Methods</h3>

        
    <h4 class="name" id="array"><span class="type-signature"></span>array<span class="signature">()</span><span class="type-signature"> &rarr; {Array}</span></h4>
    

<div class="description">
    Output hash as bytes array
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#array">Md5#array</a>
    </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#line704">line 704</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.array">md5.array</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>hash.array();</code></pre>


    <h4 class="name" id="arrayBuffer"><span class="type-signature"></span>arrayBuffer<span class="signature">()</span><span class="type-signature"> &rarr; {ArrayBuffer}</span></h4>
    

<div class="description">
    Output hash as ArrayBuffer
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#arrayBuffer">Md5#arrayBuffer</a>
    </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#line716">line 716</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.arrayBuffer">md5.arrayBuffer</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>hash.arrayBuffer();</code></pre>


    <h4 class="name" id="base64"><span class="type-signature"></span>base64<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
    

<div class="description">
    Output hash as base64 string
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#base64">Md5#base64</a>
    </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#line751">line 751</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.base64">md5.base64</a></li>
        </ul>
    </dd>
    

</dl>


<h5>Returns:</h5>

        
<div class="param-desc">
    base64 string
</div>


<dl>
    <dt>
        Type
    </dt>
    <dd>
        
<span class="param-type">String</span>


    </dd>
</dl>

    
    <h5>Example</h5>
    
    <pre class="prettyprint"><code>hash.base64();</code></pre>


    <h4 class="name" id="buffer"><span class="type-signature"></span>buffer<span class="signature">()</span><span class="type-signature"> &rarr; {ArrayBuffer}</span></h4>
    

<div class="description">
    Output hash as ArrayBuffer
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#buffer">Md5#buffer</a>
    </li></ul></dd>
    

        <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#line738">line 738</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.buffer">md5.buffer</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>hash.buffer();</code></pre>


    <h4 class="name" id="digest"><span class="type-signature"></span>digest<span class="signature">()</span><span class="type-signature"> &rarr; {Array}</span></h4>
    

<div class="description">
    Output hash as bytes array
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#digest">Md5#digest</a>
    </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#line682">line 682</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.digest">md5.digest</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>hash.digest();</code></pre>


    <h4 class="name" id="hex"><span class="type-signature"></span>hex<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
    

<div class="description">
    Output hash as hex string
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#hex">Md5#hex</a>
    </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#line637">line 637</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.hex">md5.hex</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>hash.hex();</code></pre>


    <h4 class="name" id="toString"><span class="type-signature"></span>toString<span class="signature">()</span><span class="type-signature"> &rarr; {String}</span></h4>
    

<div class="description">
    Output hash as hex string
</div>


<dl class="details">

    
    <dt class="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#toString">Md5#toString</a>
    </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#line670">line 670</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.hex">md5.hex</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>hash.toString();</code></pre>


    <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(message)</span><span class="type-signature"> &rarr; {<a href="Md5.html">Md5</a>}</span></h4>
    

<div class="description">
    Update hash
</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="inherited-from">Inherited From:</dt>
    <dd class="inherited-from"><ul class="dummy"><li>
        <a href="Md5.html#update">Md5#update</a>
    </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#line345">line 345</a>
    </li></ul></dd>
    

    <dt class="tag-see">See:</dt>
    <dd class="tag-see">
        <ul>
            <li><a href="md5_.html#.update">md5.update</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>

    
</article>

</section>


</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="md5_.html">md5</a></li><li><a href="md5.hmac.html">hmac</a></li></ul><h3>Classes</h3><ul><li><a href="HmacMd5.html">HmacMd5</a></li><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/jsdoc/jsdoc">JSDoc 4.0.2</a> on Wed Sep 27 2023 21:32:04 GMT+0800 (台北標準時間)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>