Skip to content

Commit 726ae17

Browse files
author
Ruslan Tereshchenko
committed
update docs
1 parent 0b7e0b5 commit 726ae17

File tree

12 files changed

+10886
-10572
lines changed

12 files changed

+10886
-10572
lines changed

‎docs/ast/source/document.js.json

Lines changed: 4348 additions & 4348 deletions
Large diffs are not rendered by default.

‎docs/ast/source/template.js.json

Lines changed: 6381 additions & 6171 deletions
Large diffs are not rendered by default.

‎docs/badge.svg

Lines changed: 2 additions & 2 deletions
Loading

‎docs/class/lib/document.js~Document.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -462,7 +462,7 @@ <h1 data-ice="name">Document</h1>
462462

463463

464464

465-
<span class="code" data-ice="name"><span><a href="class/lib/document.js~Document.html#static-method-view">view</a></span></span><span class="code" data-ice="signature">(data: <span> DocumentViewParams </span>, callback: <span><span>function</span><span>(err: <span><a href="typedef/index.html#static-typedef-ApiErrorResponse">ApiErrorResponse</a></span>, res: <span><a href="typedef/index.html#static-typedef-DocumentViewResponse">DocumentViewResponse</a></span>)</span></span>)</span>
465+
<span class="code" data-ice="name"><span><a href="class/lib/document.js~Document.html#static-method-view">view</a></span></span><span class="code" data-ice="signature">(data: <span><a href="typedef/index.html#static-typedef-DocumentViewParams">DocumentViewParams</a></span>, callback: <span><span>function</span><span>(err: <span><a href="typedef/index.html#static-typedef-ApiErrorResponse">ApiErrorResponse</a></span>, res: <span><a href="typedef/index.html#static-typedef-DocumentViewResponse">DocumentViewResponse</a></span>)</span></span>)</span>
466466
</p>
467467
</div>
468468
<div>
@@ -1236,7 +1236,7 @@ <h3 data-ice="anchor" id="static-method-view">
12361236

12371237

12381238

1239-
<span class="code" data-ice="name">view</span><span class="code" data-ice="signature">(data: <span> DocumentViewParams </span>, callback: <span><span>function</span><span>(err: <span><a href="typedef/index.html#static-typedef-ApiErrorResponse">ApiErrorResponse</a></span>, res: <span><a href="typedef/index.html#static-typedef-DocumentViewResponse">DocumentViewResponse</a></span>)</span></span>)</span>
1239+
<span class="code" data-ice="name">view</span><span class="code" data-ice="signature">(data: <span><a href="typedef/index.html#static-typedef-DocumentViewParams">DocumentViewParams</a></span>, callback: <span><span>function</span><span>(err: <span><a href="typedef/index.html#static-typedef-ApiErrorResponse">ApiErrorResponse</a></span>, res: <span><a href="typedef/index.html#static-typedef-DocumentViewResponse">DocumentViewResponse</a></span>)</span></span>)</span>
12401240
<span class="right-info">
12411241

12421242

@@ -1262,7 +1262,7 @@ <h4 data-ice="title">Params:</h4>
12621262

12631263
<tr data-ice="property" data-depth="0">
12641264
<td data-ice="name" class="code" data-depth="0">data</td>
1265-
<td data-ice="type" class="code"><span> DocumentViewParams </span></td>
1265+
<td data-ice="type" class="code"><span><a href="typedef/index.html#static-typedef-DocumentViewParams">DocumentViewParams</a></span></td>
12661266
<td data-ice="appendix"></td>
12671267
<td data-ice="description"><p>view document with field extract payload</p>
12681268
</td>

‎docs/class/lib/template.js~Template.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,13 @@
9090
</nav>
9191

9292
<div class="content" data-ice="content"><div class="header-notice">
93-
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import Template from &apos;<span><a href="file/lib/template.js.html#lineNumber20">@signnow/api-client/lib/template.js</a></span>&apos;</code></pre></div>
93+
<div data-ice="importPath" class="import-path"><pre class="prettyprint"><code data-ice="importPathCode">import Template from &apos;<span><a href="file/lib/template.js.html#lineNumber38">@signnow/api-client/lib/template.js</a></span>&apos;</code></pre></div>
9494
<span data-ice="access">public</span>
9595
<span data-ice="kind">class</span>
9696

9797

9898

99-
<span data-ice="source">| <span><a href="file/lib/template.js.html#lineNumber20">source</a></span></span>
99+
<span data-ice="source">| <span><a href="file/lib/template.js.html#lineNumber38">source</a></span></span>
100100
</div>
101101

102102
<div class="self-detail detail">
@@ -245,7 +245,7 @@ <h3 data-ice="anchor" id="static-method-create">
245245
<span class="right-info">
246246

247247

248-
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber49">source</a></span></span>
248+
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber67">source</a></span></span>
249249
</span>
250250
</h3>
251251

@@ -314,7 +314,7 @@ <h3 data-ice="anchor" id="static-method-duplicate">
314314
<span class="right-info">
315315

316316

317-
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber124">source</a></span></span>
317+
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber142">source</a></span></span>
318318
</span>
319319
</h3>
320320

@@ -383,7 +383,7 @@ <h3 data-ice="anchor" id="static-method-invite">
383383
<span class="right-info">
384384

385385

386-
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber170">source</a></span></span>
386+
<span data-ice="source"><span><a href="file/lib/template.js.html#lineNumber188">source</a></span></span>
387387
</span>
388388
</h3>
389389

‎docs/coverage.json

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
2-
"coverage": "61.29%",
2+
"coverage": "70.96%",
33
"expectCount": 31,
4-
"actualCount": 19,
4+
"actualCount": 22,
55
"files": {
66
"lib/document.js": {
77
"expectCount": 17,
@@ -30,12 +30,8 @@
3030
},
3131
"lib/template.js": {
3232
"expectCount": 7,
33-
"actualCount": 4,
34-
"undocumentLines": [
35-
13,
36-
14,
37-
15
38-
]
33+
"actualCount": 7,
34+
"undocumentLines": []
3935
},
4036
"lib/user.js": {
4137
"expectCount": 3,

‎docs/file/lib/document.js.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -336,8 +336,8 @@
336336

337337
/**
338338
* Retrieves a document detailed data
339-
* @param { DocumentViewParams } data - view document with field extract payload
340-
* @param { function(err: ApiErrorResponse, res: DocumentViewResponse) } [callback] - error first node.js callback
339+
* @param {DocumentViewParams} data - view document with field extract payload
340+
* @param {function(err: ApiErrorResponse, res: DocumentViewResponse)} [callback] - error first node.js callback
341341
*/
342342
static view ({ id, token }, callback) {
343343
https

‎docs/file/lib/template.js.html

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,8 +102,26 @@
102102
invite,
103103
view,
104104
} = require(&apos;./document&apos;);
105+
106+
/**
107+
* @type {function}
108+
* @param {DocumentRemoveParams} data - remove document payload
109+
* @param {function(err: ApiErrorResponse, res: DocumentRemoveResponse)} [callback] - error first node.js callback
110+
*/
105111
const removeDocument = remove;
112+
113+
/**
114+
* @type {function}
115+
* @param {DocumentInviteParams} data - create document invite payload
116+
* @param {function(err: ApiErrorResponse, res: DocumentInviteResponse)} [callback] - error first node.js callback
117+
*/
106118
const sendDocumentInvite = invite;
119+
120+
/**
121+
* @type {function}
122+
* @param {DocumentViewParams} data - view document with field extract payload
123+
* @param {function(err: ApiErrorResponse, res: DocumentViewResponse)} [callback] - error first node.js callback
124+
*/
107125
const getDocumentDetails = view;
108126

109127
/**

‎docs/index.json

Lines changed: 95 additions & 23 deletions
Large diffs are not rendered by default.

‎docs/source.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@
8989
</div>
9090
</nav>
9191

92-
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">19/31</span></h1>
92+
<div class="content" data-ice="content"><h1>Source <img data-ice="coverageBadge" src="./badge.svg"><span data-ice="totalCoverageCount" class="total-coverage-count">22/31</span></h1>
9393

9494
<table class="files-summary" data-ice="files" data-use-coverage="true">
9595
<thead>
@@ -108,9 +108,9 @@
108108
<td data-ice="filePath"><span><a href="file/lib/document.js.html#errorLines=17,185,40,49,508,622,637,668,9">lib/document.js</a></span></td>
109109
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/document.js~Document.html">Document</a></span></td>
110110
<td class="coverage"><span data-ice="coverage">47 %</span><span data-ice="coverageCount" class="coverage-count">8/17</span></td>
111-
<td style="display: none;" data-ice="size">25226 byte</td>
111+
<td style="display: none;" data-ice="size">25222 byte</td>
112112
<td style="display: none;" data-ice="lines">716</td>
113-
<td style="display: none;" data-ice="updated">2019-08-05 11:54:36 (UTC)</td>
113+
<td style="display: none;" data-ice="updated">2019-08-05 12:37:52 (UTC)</td>
114114
</tr>
115115
<tr data-ice="file">
116116
<td data-ice="filePath"><span><a href="file/lib/index.js.html">lib/index.js</a></span></td>
@@ -129,12 +129,12 @@
129129
<td style="display: none;" data-ice="updated">2019-07-05 13:17:55 (UTC)</td>
130130
</tr>
131131
<tr data-ice="file">
132-
<td data-ice="filePath"><span><a href="file/lib/template.js.html#errorLines=13,14,15">lib/template.js</a></span></td>
132+
<td data-ice="filePath"><span><a href="file/lib/template.js.html">lib/template.js</a></span></td>
133133
<td data-ice="identifier" class="identifiers"><span><a href="class/lib/template.js~Template.html">Template</a></span></td>
134-
<td class="coverage"><span data-ice="coverage">57 %</span><span data-ice="coverageCount" class="coverage-count">4/7</span></td>
135-
<td style="display: none;" data-ice="size">6310 byte</td>
136-
<td style="display: none;" data-ice="lines">230</td>
137-
<td style="display: none;" data-ice="updated">2019-08-05 12:27:53 (UTC)</td>
134+
<td class="coverage"><span data-ice="coverage">100 %</span><span data-ice="coverageCount" class="coverage-count">7/7</span></td>
135+
<td style="display: none;" data-ice="size">6954 byte</td>
136+
<td style="display: none;" data-ice="lines">248</td>
137+
<td style="display: none;" data-ice="updated">2019-08-05 12:37:26 (UTC)</td>
138138
</tr>
139139
<tr data-ice="file">
140140
<td data-ice="filePath"><span><a href="file/lib/user.js.html">lib/user.js</a></span></td>

‎lib/document.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -244,8 +244,8 @@ class Document {
244244

245245
/**
246246
* Retrieves a document detailed data
247-
* @param { DocumentViewParams } data - view document with field extract payload
248-
* @param { function(err: ApiErrorResponse, res: DocumentViewResponse) } [callback] - error first node.js callback
247+
* @param {DocumentViewParams} data - view document with field extract payload
248+
* @param {function(err: ApiErrorResponse, res: DocumentViewResponse)} [callback] - error first node.js callback
249249
*/
250250
static view ({ id, token }, callback) {
251251
https

‎lib/template.js

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,26 @@ const {
1010
invite,
1111
view,
1212
} = require('./document');
13+
14+
/**
15+
* @type {function}
16+
* @param {DocumentRemoveParams} data - remove document payload
17+
* @param {function(err: ApiErrorResponse, res: DocumentRemoveResponse)} [callback] - error first node.js callback
18+
*/
1319
const removeDocument = remove;
20+
21+
/**
22+
* @type {function}
23+
* @param {DocumentInviteParams} data - create document invite payload
24+
* @param {function(err: ApiErrorResponse, res: DocumentInviteResponse)} [callback] - error first node.js callback
25+
*/
1426
const sendDocumentInvite = invite;
27+
28+
/**
29+
* @type {function}
30+
* @param {DocumentViewParams} data - view document with field extract payload
31+
* @param {function(err: ApiErrorResponse, res: DocumentViewResponse)} [callback] - error first node.js callback
32+
*/
1533
const getDocumentDetails = view;
1634

1735
/**

0 commit comments

Comments
 (0)