635 lines
18 KiB
HTML
635 lines
18 KiB
HTML
|
|
<!DOCTYPE HTML>
|
|
<html lang="" >
|
|
<head>
|
|
<meta charset="UTF-8">
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<title>api-format · Polkadot API Book</title>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
|
|
<meta name="description" content="">
|
|
<meta name="generator" content="GitBook 3.2.3">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/style.css">
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-highlight/website.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-search/search.css">
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../gitbook/gitbook-plugin-fontsettings/website.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<meta name="HandheldFriendly" content="true"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1, user-scalable=no">
|
|
<meta name="apple-mobile-web-app-capable" content="yes">
|
|
<meta name="apple-mobile-web-app-status-bar-style" content="black">
|
|
<link rel="apple-touch-icon-precomposed" sizes="152x152" href="../gitbook/images/apple-touch-icon-precomposed-152.png">
|
|
<link rel="shortcut icon" href="../gitbook/images/favicon.ico" type="image/x-icon">
|
|
|
|
|
|
<link rel="next" href="../api-provider/" />
|
|
|
|
|
|
<link rel="prev" href="../api/" />
|
|
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div class="book">
|
|
<div class="book-summary">
|
|
|
|
|
|
<div id="book-search-input" role="search">
|
|
<input type="text" placeholder="Type to search" />
|
|
</div>
|
|
|
|
|
|
<nav role="navigation">
|
|
|
|
|
|
|
|
<ul class="summary">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="header">Intro</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="1.1" data-path="../">
|
|
|
|
<a href="../">
|
|
|
|
|
|
Introduction
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">API</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="2.1" data-path="../api/">
|
|
|
|
<a href="../api/">
|
|
|
|
|
|
api
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter active" data-level="2.2" data-path="./">
|
|
|
|
<a href="./">
|
|
|
|
|
|
api-format
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.3" data-path="../api-provider/">
|
|
|
|
<a href="../api-provider/">
|
|
|
|
|
|
api-provider
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.4" data-path="../api-rx/">
|
|
|
|
<a href="../api-rx/">
|
|
|
|
|
|
api-rx
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.5" data-path="../type-extrinsics/">
|
|
|
|
<a href="../type-extrinsics/">
|
|
|
|
|
|
type-extrinsics
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.6" data-path="../type-jsonrpc/">
|
|
|
|
<a href="../type-jsonrpc/">
|
|
|
|
|
|
type-jsonrpc
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.7" data-path="../type-params/">
|
|
|
|
<a href="../type-params/">
|
|
|
|
|
|
type-params
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.8" data-path="../type-primitives/">
|
|
|
|
<a href="../type-primitives/">
|
|
|
|
|
|
type-primitives
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="2.9" data-path="../type-storage/">
|
|
|
|
<a href="../type-storage/">
|
|
|
|
|
|
type-storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Examples</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="3.1" data-path="../examples/">
|
|
|
|
<a href="../examples/">
|
|
|
|
|
|
Overview
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.2" data-path="../examples/01_simple_connect/">
|
|
|
|
<a href="../examples/01_simple_connect/">
|
|
|
|
|
|
Simple connect
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.3" data-path="../examples/02_listen_to_blocks/">
|
|
|
|
<a href="../examples/02_listen_to_blocks/">
|
|
|
|
|
|
Listen to blocks
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.4" data-path="../examples/03_listen_to_balance_change/">
|
|
|
|
<a href="../examples/03_listen_to_balance_change/">
|
|
|
|
|
|
Listen to balance change
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.5" data-path="../examples/04_generate_account/">
|
|
|
|
<a href="../examples/04_generate_account/">
|
|
|
|
|
|
Generate Accounts
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.6" data-path="../examples/05_read_storage/">
|
|
|
|
<a href="../examples/05_read_storage/">
|
|
|
|
|
|
Read Storage
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.7" data-path="../examples/06_craft_extrinsic/">
|
|
|
|
<a href="../examples/06_craft_extrinsic/">
|
|
|
|
|
|
Craft Extrinsic
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
<li class="chapter " data-level="3.8" data-path="../examples/07_transfer_dots/">
|
|
|
|
<a href="../examples/07_transfer_dots/">
|
|
|
|
|
|
Transfer DOTs
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="header">Contributing</li>
|
|
|
|
|
|
|
|
<li class="chapter " data-level="4.1" data-path="../CONTRIBUTING.html">
|
|
|
|
<a href="../CONTRIBUTING.html">
|
|
|
|
|
|
Contributing guide
|
|
|
|
</a>
|
|
|
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
<li class="divider"></li>
|
|
|
|
<li>
|
|
<a href="https://www.gitbook.com" target="blank" class="gitbook-link">
|
|
Published with GitBook
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
|
|
|
|
</nav>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="book-body">
|
|
|
|
<div class="body-inner">
|
|
|
|
|
|
|
|
<div class="book-header" role="navigation">
|
|
|
|
|
|
<!-- Title -->
|
|
<h1>
|
|
<i class="fa fa-circle-o-notch fa-spin"></i>
|
|
<a href=".." >api-format</a>
|
|
</h1>
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="page-wrapper" tabindex="-1" role="main">
|
|
<div class="page-inner">
|
|
|
|
<div id="book-search-results">
|
|
<div class="search-noresults">
|
|
|
|
<section class="normal markdown-section">
|
|
|
|
<p><a href="https://polkadot.js.org" target="_blank"><img src="https://img.shields.io/badge/polkadot-js-orange.svg?style=flat-square" alt="polkadotjs"></a> <img src="https://img.shields.io/badge/license-ISC-lightgrey.svg?style=flat-square" alt="isc"> <a href="https://github.com/Flet/semistandard" target="_blank"><img src="https://img.shields.io/badge/code%20style-semistandard-lightgrey.svg?style=flat-square" alt="style"></a> <a href="https://www.npmjs.com/package/@polkadot/api-format" target="_blank"><img src="https://img.shields.io/npm/v/@polkadot/api-format.svg?style=flat-square" alt="npm"></a> <a href="https://travis-ci.org/polkadot-js/api" target="_blank"><img src="https://img.shields.io/travis/polkadot-js/api.svg?style=flat-square" alt="travis"></a> <a href="https://codeclimate.com/github/polkadot-js/api/maintainability" target="_blank"><img src="https://img.shields.io/codeclimate/maintainability/polkadot-js/api.svg?style=flat-square" alt="maintainability"></a> <a href="https://coveralls.io/github/polkadot-js/api?branch=master" target="_blank"><img src="https://img.shields.io/coveralls/polkadot-js/api.svg?style=flat-square" alt="coverage"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/api-format" target="_blank"><img src="https://david-dm.org/polkadot-js/api.svg?style=flat-square&path=packages/api-format" alt="dependency"></a> <a href="https://david-dm.org/polkadot-js/api?path=packages/api-format#info=devDependencies" target="_blank"><img src="https://david-dm.org/polkadot-js/api/dev-status.svg?style=flat-square&path=packages/api-format" alt="devDependency"></a></p>
|
|
<h1 id="polkadotapi-format">@polkadot/api-format</h1>
|
|
<p>Formatters that are used by the application API interface, taking care of transparently formatting parameters (inputs) and the results (output) for requests made over the client RPC interfaces.</p>
|
|
<h2 id="usage">Usage</h2>
|
|
<p>Installation -</p>
|
|
<pre><code>npm install --save @polkadot/api-format
|
|
</code></pre><h2 id="index">Index</h2>
|
|
<h3 id="type-aliases">Type aliases</h3>
|
|
<ul>
|
|
<li><a href="#formatterfunction">FormatterFunction</a></li>
|
|
</ul>
|
|
<h3 id="functions">Functions</h3>
|
|
<ul>
|
|
<li><a href="#echo">echo</a></li>
|
|
<li><a href="#format">format</a></li>
|
|
<li><a href="#formatinputs">formatInputs</a></li>
|
|
<li><a href="#formatoutput">formatOutput</a></li>
|
|
</ul>
|
|
<hr>
|
|
<h2 id="type-aliases">Type aliases</h2>
|
|
<p><a id="formatterfunction"></a></p>
|
|
<h3 id="formatterfunction">FormatterFunction</h3>
|
|
<p><strong>Ƭ FormatterFunction</strong>: <em><code>function</code></em></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-format/src/types.d.ts#L7" target="_blank">types.d.ts:7</a></em></p>
|
|
<h4 id="type-declaration">Type declaration</h4>
|
|
<p>▸(value: <em><code>any</code></em>): <code>any</code></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><code>any</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>any</code></p>
|
|
<hr>
|
|
<h2 id="functions">Functions</h2>
|
|
<p><a id="echo"></a></p>
|
|
<h3 id="echo">echo</h3>
|
|
<p>▸ <strong>echo</strong>(value: <em><code>any</code></em>): <code>any</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-format/src/echo.ts#L10" target="_blank">echo.ts:10</a></em></p>
|
|
<p>A function returning any value passed to it</p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>value</td>
|
|
<td><code>any</code></td>
|
|
<td>The input value</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>any</code>
|
|
The value passed as input</p>
|
|
<hr>
|
|
<p><a id="format"></a></p>
|
|
<h3 id="format">format</h3>
|
|
<p>▸ <strong>format</strong>(formatters: <em><code>FormattersFunctionMap</code></em>, types: <em><code>Array</code><<code>Param$Types</code>></em>, values: <em><code>Array</code><<code>any</code>></em>): <code>Array</code><<code>any</code>></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-format/src/format.ts#L49" target="_blank">format.ts:49</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>formatters</td>
|
|
<td><code>FormattersFunctionMap</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>types</td>
|
|
<td><code>Array</code><<code>Param$Types</code>></td>
|
|
</tr>
|
|
<tr>
|
|
<td>values</td>
|
|
<td><code>Array</code><<code>any</code>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Array</code><<code>any</code>></p>
|
|
<hr>
|
|
<p><a id="formatinputs"></a></p>
|
|
<h3 id="formatinputs">formatInputs</h3>
|
|
<p>▸ <strong>formatInputs</strong>(params: <em><code>Params</code></em>, values: <em><code>Array</code><<code>any</code>></em>): <code>Array</code><<code>any</code>></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-format/src/input.ts#L22" target="_blank">input.ts:22</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>params</td>
|
|
<td><code>Params</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td>values</td>
|
|
<td><code>Array</code><<code>any</code>></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>Array</code><<code>any</code>></p>
|
|
<hr>
|
|
<p><a id="formatoutput"></a></p>
|
|
<h3 id="formatoutput">formatOutput</h3>
|
|
<p>▸ <strong>formatOutput</strong>(type: <em><code>Param$Types</code></em>, value?: <em><code>any</code></em>): <code>any</code> | <code>null</code></p>
|
|
<p><em>Defined in <a href="https://github.com/polkadot-js/api/blob/f5b0e23/packages/api-format/src/output.ts#L30" target="_blank">output.ts:30</a></em></p>
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Param</th>
|
|
<th>Type</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>type</td>
|
|
<td><code>Param$Types</code></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>Optional</code> value</td>
|
|
<td><code>any</code></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<p><strong>Returns:</strong> <code>any</code> | <code>null</code></p>
|
|
<hr>
|
|
|
|
|
|
</section>
|
|
|
|
</div>
|
|
<div class="search-results">
|
|
<div class="has-results">
|
|
|
|
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
|
|
<ul class="search-results-list"></ul>
|
|
|
|
</div>
|
|
<div class="no-results">
|
|
|
|
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<a href="../api/" class="navigation navigation-prev " aria-label="Previous page: api">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
|
|
<a href="../api-provider/" class="navigation navigation-next " aria-label="Next page: api-provider">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
<script>
|
|
var gitbook = gitbook || [];
|
|
gitbook.push(function() {
|
|
gitbook.page.hasChanged({"page":{"title":"api-format","level":"2.2","depth":1,"next":{"title":"api-provider","level":"2.3","depth":1,"path":"api-provider/README.md","ref":"api-provider/README.md","articles":[]},"previous":{"title":"api","level":"2.1","depth":1,"path":"api/README.md","ref":"api/README.md","articles":[]},"dir":"ltr"},"config":{"plugins":["asciidoc-include"],"root":"docs","styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"asciidoc-include":{"syntax":"asciidoc"},"highlight":{},"search":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"sharing":{"facebook":true,"twitter":true,"google":false,"weibo":false,"instapaper":false,"vk":false,"all":["facebook","google","twitter","weibo","instapaper"]},"fontsettings":{"theme":"white","family":"sans","size":2},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":false}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"Polkadot API Book","gitbook":">=2.4.0"},"file":{"path":"api-format/README.md","mtime":"2018-09-17T12:35:34.689Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-09-17T12:37:27.221Z"},"basePath":"..","book":{"language":""}});
|
|
});
|
|
</script>
|
|
</div>
|
|
|
|
|
|
<script src="../gitbook/gitbook.js"></script>
|
|
<script src="../gitbook/theme.js"></script>
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search-engine.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-search/search.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/lunr.min.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-lunr/search-lunr.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-sharing/buttons.js"></script>
|
|
|
|
|
|
|
|
<script src="../gitbook/gitbook-plugin-fontsettings/fontsettings.js"></script>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|
|
|