<!DOCTYPE html>

<html lang="en">

<head>

<meta charset="utf-8">

<title>Class: Encoder</title>

<script src="scripts/prettify/prettify.js"> </script>

<script src="scripts/prettify/lang-css.js"> </script>

<!--[if lt IE 9]>

<script src="scripts/html5.js"></script>

<![endif]-->

<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">

<link type="text/css" rel="stylesheet" href="styles/jsdoc-esoccer.css">

</head>

<body>

<div id="main">

<h1 class="page-title">Class: Encoder</h1>

<section>

<header>

<h2>

<span class="ancestors"><a href="PSON.html">PSON</a>.</span>

Encoder

</h2>

<div class="class-description"><p>A PSON Encoder.</p></div>

</header>

<article>

<div class="container-overview">

<dt>

<h4 class="name" id="Encoder"><span class="type-signature"></span>new Encoder<span class="signature">(<span class="optional">dict</span>, progressive, <span class="optional">options</span>)</span><span class="type-signature"></span></h4>

</dt>

<dd>

<div class="description">

<p>Constructs a new PSON Encoder.</p>

</div>

<h5>Parameters:</h5>

<table class="params">

<thead>

<tr>

<th>Name</th>

<th>Type</th>

<th>Argument</th>

<th class="last">Description</th>

</tr>

</thead>

<tbody>

<tr>

<td class="name"><code>dict</code></td>

<td class="type">

<span class="param-type">Array.&lt;string></span>

</td>

<td class="attributes">

&lt;optional><br>

</td>

<td class="description last"><p>Initial dictionary</p></td>

</tr>

<tr>

<td class="name"><code>progressive</code></td>

<td class="type">

<span class="param-type">boolean</span>

</td>

<td class="attributes">

</td>

<td class="description last"><p>Whether this is a progressive or a static encoder</p></td>

</tr>

<tr>

<td class="name"><code>options</code></td>

<td class="type">

<span class="param-type">Object.&lt;string,*></span>

</td>

<td class="attributes">

&lt;optional><br>

</td>

<td class="description last"><p>Options</p></td>

</tr>

</tbody>

</table>

<dl class="details">

</dl>

</dd>

</div>

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

<dl>

<dt>

<h4 class="name" id="dict"><span class="type-signature"></span>dict<span class="type-signature"> :Object.&lt;string,number></span></h4>

</dt>

<dd>

<div class="description">

<p>Dictionary hash.</p>

</div>

<dl class="details">

</dl>

</dd>

<dt>

<h4 class="name" id="next"><span class="type-signature"></span>next<span class="type-signature"> :number</span></h4>

</dt>

<dd>

<div class="description">

<p>Next dictionary index.</p>

</div>

<dl class="details">

</dl>

</dd>

<dt>

<h4 class="name" id="options"><span class="type-signature"></span>options<span class="type-signature"> :Object.&lt;string,*></span></h4>

</dt>

<dd>

<div class="description">

<p>Options.</p>

</div>

<dl class="details">

</dl>

</dd>

<dt>

<h4 class="name" id="progressive"><span class="type-signature"></span>progressive<span class="type-signature"> :boolean</span></h4>

</dt>

<dd>

<div class="description">

<p>Whether the encoder is progressive or static.</p>

</div>

<dl class="details">

</dl>

</dd>

</dl>

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

<dl>

<dt>

<h4 class="name" id="encode"><span class="type-signature"></span>encode<span class="signature">(json, <span class="optional">buf</span>)</span><span class="type-signature"> &rarr; {ByteBuffer}</span></h4>

</dt>

<dd>

<div class="description">

<p>Encodes JSON to PSON.</p>

</div>

<h5>Parameters:</h5>

<table class="params">

<thead>

<tr>

<th>Name</th>

<th>Type</th>

<th>Argument</th>

<th class="last">Description</th>

</tr>

</thead>

<tbody>

<tr>

<td class="name"><code>json</code></td>

<td class="type">

<span class="param-type">*</span>

</td>

<td class="attributes">

</td>

<td class="description last"><p>JSON</p></td>

</tr>

<tr>

<td class="name"><code>buf</code></td>

<td class="type">

<span class="param-type">(!ByteBuffer)</span>

</td>

<td class="attributes">

&lt;optional><br>

</td>

<td class="description last"><p>Buffer to encode to. When omitted, the resulting ByteBuffer will be flipped. When

specified, it will not be flipped.</p></td>

</tr>

</tbody>

</table>

<dl class="details">

</dl>

<h5>Returns:</h5>

<div class="param-desc">

<p>PSON</p>

</div>

<dl>

<dt>

Type

</dt>

<dd>

<span class="param-type">ByteBuffer</span>

</dd>

</dl>

</dd>

</dl>

</article>

</section>

</div>

<nav>

<nav-inner>

<h2><a href="index.html">Index</a></h2><h3>Classes</h3><ul><li><a href="PSON.Decoder.html">Decoder</a></li><li><a href="PSON.Encoder.html">Encoder</a></li><li><a href="PSON.Pair.html">Pair</a></li><li><a href="PSON.ProgressivePair.html">ProgressivePair</a></li><li><a href="PSON.StaticPair.html">StaticPair</a></li></ul><h3>Namespaces</h3><ul><li><a href="PSON.html">PSON</a></li><li><a href="PSON.T.html">T</a></li></ul>

</nav-inner>

</nav>

<br clear="both">

<script> prettyPrint(); </script>

</body>

</html>