This repository was archived by the owner on Jul 10, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathapitemplate.html
More file actions
59 lines (53 loc) · 13.5 KB
/
apitemplate.html
File metadata and controls
59 lines (53 loc) · 13.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>method_template | Laksa</title>
<meta name="description" content="Zilliqa BlockChain Javascript API">
<link rel="preload" href="/Laksa-docs/assets/css/0.styles.ad03052c.css" as="style"><link rel="preload" href="/Laksa-docs/assets/js/app.915bd5b2.js" as="script"><link rel="preload" href="/Laksa-docs/assets/js/9.cdb372bc.js" as="script"><link rel="prefetch" href="/Laksa-docs/assets/js/10.51e8c64f.js"><link rel="prefetch" href="/Laksa-docs/assets/js/11.4ccfd63d.js"><link rel="prefetch" href="/Laksa-docs/assets/js/12.7d04d408.js"><link rel="prefetch" href="/Laksa-docs/assets/js/13.9662df95.js"><link rel="prefetch" href="/Laksa-docs/assets/js/14.16296ff8.js"><link rel="prefetch" href="/Laksa-docs/assets/js/15.63c87db7.js"><link rel="prefetch" href="/Laksa-docs/assets/js/16.ee0914f5.js"><link rel="prefetch" href="/Laksa-docs/assets/js/17.ab9cfff9.js"><link rel="prefetch" href="/Laksa-docs/assets/js/18.f2955104.js"><link rel="prefetch" href="/Laksa-docs/assets/js/19.2f9092b8.js"><link rel="prefetch" href="/Laksa-docs/assets/js/20.672ba0ed.js"><link rel="prefetch" href="/Laksa-docs/assets/js/21.a4b1ed18.js"><link rel="prefetch" href="/Laksa-docs/assets/js/22.e5fc6571.js"><link rel="prefetch" href="/Laksa-docs/assets/js/23.85e35b31.js"><link rel="prefetch" href="/Laksa-docs/assets/js/3.34058b88.js"><link rel="prefetch" href="/Laksa-docs/assets/js/4.eea39184.js"><link rel="prefetch" href="/Laksa-docs/assets/js/5.c8bc3a65.js"><link rel="prefetch" href="/Laksa-docs/assets/js/6.0f8fa8f3.js"><link rel="prefetch" href="/Laksa-docs/assets/js/7.e889666c.js"><link rel="prefetch" href="/Laksa-docs/assets/js/8.d3a0e380.js"><link rel="prefetch" href="/Laksa-docs/assets/js/vendors~docsearch.d69e689a.js">
<link rel="stylesheet" href="/Laksa-docs/assets/css/0.styles.ad03052c.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/Laksa-docs/" class="home-link router-link-active"><!----> <span class="site-name">Laksa</span></a> <div class="links" style="max-width:nullpx;"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/Laksa-docs/" class="nav-link">Intro</a></div><div class="nav-item"><a href="/Laksa-docs/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/Laksa-docs/api/" class="nav-link">API Reference</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/Laksa-docs/apitemplate.html" class="nav-link router-link-exact-active router-link-active">English</a></li><li class="dropdown-item"><!----> <a href="/Laksa-docs/zh/" class="nav-link">简体中文</a></li></ul></div></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <div class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/Laksa-docs/" class="nav-link">Intro</a></div><div class="nav-item"><a href="/Laksa-docs/guide/" class="nav-link">Guide</a></div><div class="nav-item"><a href="/Laksa-docs/api/" class="nav-link">API Reference</a></div><div class="nav-item"><div class="dropdown-wrapper"><a class="dropdown-title"><span class="title">Languages</span> <span class="arrow right"></span></a> <ul class="nav-dropdown" style="display:none;"><li class="dropdown-item"><!----> <a href="/Laksa-docs/apitemplate.html" class="nav-link router-link-exact-active router-link-active">English</a></li><li class="dropdown-item"><!----> <a href="/Laksa-docs/zh/" class="nav-link">简体中文</a></li></ul></div></div> <!----></nav> <ul class="sidebar-links"><li><a href="/Laksa-docs/" class="sidebar-link">Laksa</a></li></ul> </div> <div class="page"> <div class="content"><h3 id="method-template"><a href="#method-template" aria-hidden="true" class="header-anchor">#</a> method_template</h3> <p>{description template}</p> <div class="warning custom-block"><p class="custom-block-title">WARNING</p> <p>This Method is not open tested yet</p> <p><code>DO NOT</code> use it.</p></div> <h4 id="typed"><a href="#typed" aria-hidden="true" class="header-anchor">#</a> Typed</h4> <div class="language-flow extra-class"><pre class="language-flow"><code> <span class="token function">method</span><span class="token punctuation">(</span><span class="token punctuation">{</span> params<span class="token punctuation">:</span> <span class="token keyword">type</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> callback<span class="token operator">?</span><span class="token punctuation">:</span> <span class="token type tag">void</span><span class="token punctuation">)</span><span class="token operator">=></span> Promises<span class="token operator"><</span>Error<span class="token operator">|</span><span class="token type tag">boolean</span><span class="token operator">|</span><span class="token type tag">string</span><span class="token operator">|</span><span class="token type tag">number</span><span class="token operator">|</span><span class="token type tag">any</span><span class="token operator">|</span>object<span class="token operator"><</span><span class="token constant">T</span><span class="token operator">>></span><span class="token punctuation">;</span>
</code></pre></div><h4 id="parameters"><a href="#parameters" aria-hidden="true" class="header-anchor">#</a> parameters</h4> <ul><li><ol><li><p><code>object</code>- required, see below</p> <table><thead><tr><th style="text-align:left">key</th> <th style="text-align:left">type</th> <th style="text-align:left">required?</th> <th style="text-align:left">example</th> <th style="text-align:left">description</th></tr></thead> <tbody><tr><td style="text-align:left">code</td> <td style="text-align:left"><code>string</code></td> <td style="text-align:left">yes</td> <td style="text-align:left">{template}</td> <td style="text-align:left">{template}</td></tr></tbody></table></li></ol></li> <li><ol start="2"><li><code>function</code>- optional, callback function, Error as the first parameter，normal result will be as the second parameter，see examples:</li></ol> <div class="language-flow extra-class"><pre class="language-flow"><code><span class="token keyword">function</span> <span class="token function">callback</span><span class="token punctuation">(</span>err<span class="token punctuation">:</span> Error<span class="token punctuation">,</span> data<span class="token punctuation">:</span> <span class="token type tag">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token type tag">void</span> <span class="token punctuation">{</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// do with error</span>
<span class="token punctuation">}</span>
<span class="token comment">// do with data</span>
<span class="token punctuation">}</span>
</code></pre></div></li></ul> <h4 id="returns"><a href="#returns" aria-hidden="true" class="header-anchor">#</a> returns</h4> <ul><li><code>Promises<Error|boolean|string|number|any|object<T>></code> {template},otherwise Error</li></ul> <h4 id="usage"><a href="#usage" aria-hidden="true" class="header-anchor">#</a> usage</h4> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// // suppose Laksa is initialized</span>
<span class="token comment">// const code = "scilla code";</span>
<span class="token comment">// // use callback to get the result</span>
<span class="token comment">// Laksa.zil.checkCodeTest({ code: code }, (err, data) => {</span>
<span class="token comment">// if (err) {</span>
<span class="token comment">// console.log(err);</span>
<span class="token comment">// }</span>
<span class="token comment">// console.log(data);</span>
<span class="token comment">// });</span>
<span class="token comment">//</span>
<span class="token comment">// // use then to return Promises</span>
<span class="token comment">// Laksa.zil.checkCodeTest({ code: code }).then(console.log);</span>
</code></pre></div><hr> <h3 id="方法模板"><a href="#方法模板" aria-hidden="true" class="header-anchor">#</a> 方法模板</h3> <p>{文字模板}</p> <div class="warning custom-block"><p class="custom-block-title">警告</p> <p>这个方法还没有开放测试</p> <p><code>不要</code> 使用！</p></div> <h4 id="typed-2"><a href="#typed-2" aria-hidden="true" class="header-anchor">#</a> Typed</h4> <div class="language-flow extra-class"><pre class="language-flow"><code> <span class="token function">method</span><span class="token punctuation">(</span><span class="token punctuation">{</span> params<span class="token punctuation">:</span> <span class="token keyword">type</span><span class="token punctuation">}</span><span class="token punctuation">,</span> callback<span class="token operator">?</span><span class="token punctuation">:</span> <span class="token type tag">void</span><span class="token punctuation">)</span><span class="token operator">=></span> Promises<span class="token operator"><</span>Error<span class="token operator">|</span><span class="token type tag">boolean</span><span class="token operator">|</span><span class="token type tag">string</span><span class="token operator">|</span><span class="token type tag">number</span><span class="token operator">|</span><span class="token type tag">any</span><span class="token operator">|</span>object<span class="token operator"><</span><span class="token constant">T</span><span class="token operator">>></span><span class="token punctuation">;</span>
</code></pre></div><h4 id="参数"><a href="#参数" aria-hidden="true" class="header-anchor">#</a> 参数</h4> <ul><li><ol><li><p><code>object</code>- 必须, 见下表</p> <table><thead><tr><th style="text-align:left">键名</th> <th style="text-align:left">类型</th> <th style="text-align:left">必须</th> <th style="text-align:left">实例</th> <th style="text-align:left">描述</th></tr></thead> <tbody><tr><td style="text-align:left">params</td> <td style="text-align:left"><code>type</code></td> <td style="text-align:left">是</td> <td style="text-align:left">{文字模板}</td> <td style="text-align:left">{文字模板}</td></tr></tbody></table></li></ol></li> <li><ol start="2"><li><code>function</code>- 可选, 回调函数, 第一个参数为 Error 对象，第二个参数为正常返回结果，建议格式如下:</li></ol> <div class="language-flow extra-class"><pre class="language-flow"><code><span class="token keyword">function</span> <span class="token function">callback</span><span class="token punctuation">(</span>err<span class="token punctuation">:</span> Error<span class="token punctuation">,</span> data<span class="token punctuation">:</span> <span class="token type tag">any</span><span class="token punctuation">)</span><span class="token punctuation">:</span> <span class="token type tag">void</span> <span class="token punctuation">{</span>
<span class="token keyword">if</span> <span class="token punctuation">(</span>err<span class="token punctuation">)</span> <span class="token punctuation">{</span>
<span class="token comment">// do with error</span>
<span class="token punctuation">}</span>
<span class="token comment">// do with data</span>
<span class="token punctuation">}</span>
</code></pre></div></li></ul> <h4 id="返回"><a href="#返回" aria-hidden="true" class="header-anchor">#</a> 返回</h4> <ul><li><code>Promises<Error|boolean|string|number|any|object<T>></code> {文字模板}，报错返回 Error</li></ul> <h4 id="用法"><a href="#用法" aria-hidden="true" class="header-anchor">#</a> 用法</h4> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token comment">// // 假设 Laksa 已经初始化</span>
<span class="token comment">// const code = "scilla code";</span>
<span class="token comment">// // 使用callback获取结果</span>
<span class="token comment">// Laksa.zil.checkCodeTest({ code: code }, (err, data) => {</span>
<span class="token comment">// if (err) {</span>
<span class="token comment">// console.log(err);</span>
<span class="token comment">// }</span>
<span class="token comment">// console.log(data);</span>
<span class="token comment">// });</span>
<span class="token comment">//</span>
<span class="token comment">// // 使用then返回Promises</span>
<span class="token comment">// Laksa.zil.checkCodeTest({ code: code }).then(console.log);</span>
</code></pre></div><hr></div> <div class="page-edit"><!----> <!----></div> <!----> </div> <!----></div></div>
<script src="/Laksa-docs/assets/js/app.915bd5b2.js" defer></script><script src="/Laksa-docs/assets/js/9.cdb372bc.js" defer></script>
</body>
</html>