Skip to content

Commit deb534d

Browse files
chore(release): 5.3.0 [skip ci]
# [5.3.0](v5.2.0...v5.3.0) (2019-03-07) ### Features * **user-agent:** review user-agent header value ([e182cd4](e182cd4))
1 parent 32e9f91 commit deb534d

File tree

15 files changed

+218
-149
lines changed

15 files changed

+218
-149
lines changed

HISTORY.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
# [5.3.0](https://github.com/hexonet/node-sdk/compare/v5.2.0...v5.3.0) (2019-03-07)
2+
3+
4+
### Features
5+
6+
* **user-agent:** review user-agent header value ([e182cd4](https://github.com/hexonet/node-sdk/commit/e182cd4))
7+
18
# [5.2.0](https://github.com/hexonet/node-sdk/compare/v5.1.0...v5.2.0) (2018-11-02)
29

310

docs/docco/src/apiclient.html

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,10 @@ <h1>apiclient.ts</h1>
113113
* API connection timeout setting
114114
*/</span>
115115
<span class="hljs-keyword">private</span> <span class="hljs-keyword">static</span> readonly socketTimeout: <span class="hljs-built_in">number</span> = <span class="hljs-number">300000</span>;
116+
<span class="hljs-comment">/**
117+
* User Agent string
118+
*/</span>
119+
<span class="hljs-keyword">private</span> ua: <span class="hljs-built_in">string</span>;
116120
<span class="hljs-comment">/**
117121
* API connection url
118122
*/</span>
@@ -131,6 +135,7 @@ <h1>apiclient.ts</h1>
131135
<span class="hljs-keyword">private</span> logger: <span class="hljs-function">(<span class="hljs-params">post: <span class="hljs-built_in">string</span>, r: Response, error?: <span class="hljs-built_in">Error</span></span>) =&gt;</span> <span class="hljs-built_in">any</span>;
132136

133137
<span class="hljs-keyword">public</span> <span class="hljs-keyword">constructor</span>(<span class="hljs-params"></span>) {
138+
<span class="hljs-keyword">this</span>.ua = <span class="hljs-string">""</span>;
134139
<span class="hljs-keyword">this</span>.socketURL = <span class="hljs-string">""</span>;
135140
<span class="hljs-keyword">this</span>.debugMode = <span class="hljs-literal">false</span>;
136141
<span class="hljs-keyword">this</span>.setURL(<span class="hljs-string">"https://coreapi.1api.net/api/call.cgi"</span>);
@@ -211,6 +216,17 @@ <h1>apiclient.ts</h1>
211216
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.socketURL;
212217
}
213218

219+
<span class="hljs-comment">/**
220+
* Get the User Agent
221+
* @returns User Agent string
222+
*/</span>
223+
<span class="hljs-keyword">public</span> getUserAgent(): <span class="hljs-built_in">string</span> {
224+
<span class="hljs-keyword">if</span> (!<span class="hljs-keyword">this</span>.ua.length) {
225+
<span class="hljs-keyword">this</span>.ua = <span class="hljs-string">`NODE-SDK (<span class="hljs-subst">${process.platform}</span>; <span class="hljs-subst">${process.arch}</span>; rv:<span class="hljs-subst">${this.getVersion()}</span>) node<span class="hljs-subst">${process.version}</span>`</span>;
226+
}
227+
<span class="hljs-keyword">return</span> <span class="hljs-keyword">this</span>.ua;
228+
}
229+
214230
<span class="hljs-comment">/**
215231
* Get the current module version
216232
* @returns module version
@@ -316,7 +332,7 @@ <h1>apiclient.ts</h1>
316332
*/</span>
317333
<span class="hljs-keyword">public</span> <span class="hljs-keyword">async</span> login(otp: <span class="hljs-built_in">string</span> = <span class="hljs-string">""</span>): <span class="hljs-built_in">Promise</span>&lt;Response&gt; {
318334
<span class="hljs-keyword">this</span>.setOTP(otp || <span class="hljs-string">""</span>);
319-
<span class="hljs-keyword">const</span> rr = <span class="hljs-keyword">await</span> <span class="hljs-keyword">this</span>.request({ COMMAND: <span class="hljs-string">"StartSession"</span>});
335+
<span class="hljs-keyword">const</span> rr = <span class="hljs-keyword">await</span> <span class="hljs-keyword">this</span>.request({ COMMAND: <span class="hljs-string">"StartSession"</span> });
320336
<span class="hljs-keyword">if</span> (rr.isSuccess()) {
321337
<span class="hljs-keyword">const</span> col = rr.getColumn(<span class="hljs-string">"SESSION"</span>);
322338
<span class="hljs-keyword">this</span>.setSession(col ? col.getData()[<span class="hljs-number">0</span>] : <span class="hljs-string">""</span>);
@@ -384,7 +400,7 @@ <h1>apiclient.ts</h1>
384400
form: data,
385401
gzip: <span class="hljs-literal">true</span>,
386402
headers: {
387-
<span class="hljs-string">"User-Agent"</span>: <span class="hljs-string">`node-sdk::<span class="hljs-subst">${this.getVersion()}</span>`</span>,
403+
<span class="hljs-string">"User-Agent"</span>: <span class="hljs-keyword">this</span>.getUserAgent(),
388404
},
389405
method: <span class="hljs-string">"POST"</span>,
390406
timeout: APIClient.socketTimeout,

docs/typedoc/assets/js/search.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/typedoc/classes/apiclient.html

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

docs/typedoc/classes/column.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h3>constructor</h3>
121121
<li class="tsd-description">
122122
<aside class="tsd-sources">
123123
<ul>
124-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L16">column.ts:16</a></li>
124+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L16">column.ts:16</a></li>
125125
</ul>
126126
</aside>
127127
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -146,7 +146,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> data</h3>
146146
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
147147
<aside class="tsd-sources">
148148
<ul>
149-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L16">column.ts:16</a></li>
149+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L16">column.ts:16</a></li>
150150
</ul>
151151
</aside>
152152
<div class="tsd-comment tsd-typography">
@@ -161,7 +161,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> key</h3>
161161
<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162162
<aside class="tsd-sources">
163163
<ul>
164-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L12">column.ts:12</a></li>
164+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L12">column.ts:12</a></li>
165165
</ul>
166166
</aside>
167167
<div class="tsd-comment tsd-typography">
@@ -176,7 +176,7 @@ <h3>length</h3>
176176
<div class="tsd-signature tsd-kind-icon">length<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
177177
<aside class="tsd-sources">
178178
<ul>
179-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L8">column.ts:8</a></li>
179+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L8">column.ts:8</a></li>
180180
</ul>
181181
</aside>
182182
<div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@ <h3>get<wbr>Data</h3>
198198
<li class="tsd-description">
199199
<aside class="tsd-sources">
200200
<ul>
201-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L36">column.ts:36</a></li>
201+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L36">column.ts:36</a></li>
202202
</ul>
203203
</aside>
204204
<div class="tsd-comment tsd-typography">
@@ -221,7 +221,7 @@ <h3>get<wbr>Data<wbr>ByIndex</h3>
221221
<li class="tsd-description">
222222
<aside class="tsd-sources">
223223
<ul>
224-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L45">column.ts:45</a></li>
224+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L45">column.ts:45</a></li>
225225
</ul>
226226
</aside>
227227
<div class="tsd-comment tsd-typography">
@@ -256,7 +256,7 @@ <h3>get<wbr>Key</h3>
256256
<li class="tsd-description">
257257
<aside class="tsd-sources">
258258
<ul>
259-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L28">column.ts:28</a></li>
259+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L28">column.ts:28</a></li>
260260
</ul>
261261
</aside>
262262
<div class="tsd-comment tsd-typography">
@@ -279,7 +279,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> has<wbr>Data<wbr>Index<
279279
<li class="tsd-description">
280280
<aside class="tsd-sources">
281281
<ul>
282-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/column.ts#L54">column.ts:54</a></li>
282+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/column.ts#L54">column.ts:54</a></li>
283283
</ul>
284284
</aside>
285285
<div class="tsd-comment tsd-typography">

docs/typedoc/classes/record.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -118,7 +118,7 @@ <h3>constructor</h3>
118118
<li class="tsd-description">
119119
<aside class="tsd-sources">
120120
<ul>
121-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/record.ts#L8">record.ts:8</a></li>
121+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/record.ts#L8">record.ts:8</a></li>
122122
</ul>
123123
</aside>
124124
<div class="tsd-comment tsd-typography">
@@ -150,7 +150,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> data</h3>
150150
<div class="tsd-signature tsd-kind-icon">data<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
151151
<aside class="tsd-sources">
152152
<ul>
153-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/record.ts#L8">record.ts:8</a></li>
153+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/record.ts#L8">record.ts:8</a></li>
154154
</ul>
155155
</aside>
156156
<div class="tsd-comment tsd-typography">
@@ -172,7 +172,7 @@ <h3>get<wbr>Data</h3>
172172
<li class="tsd-description">
173173
<aside class="tsd-sources">
174174
<ul>
175-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/record.ts#L22">record.ts:22</a></li>
175+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/record.ts#L22">record.ts:22</a></li>
176176
</ul>
177177
</aside>
178178
<div class="tsd-comment tsd-typography">
@@ -195,7 +195,7 @@ <h3>get<wbr>Data<wbr>ByKey</h3>
195195
<li class="tsd-description">
196196
<aside class="tsd-sources">
197197
<ul>
198-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/record.ts#L31">record.ts:31</a></li>
198+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/record.ts#L31">record.ts:31</a></li>
199199
</ul>
200200
</aside>
201201
<div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@ <h3><span class="tsd-flag ts-flagPrivate">Private</span> has<wbr>Data</h3>
230230
<li class="tsd-description">
231231
<aside class="tsd-sources">
232232
<ul>
233-
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/f3379a3/src/record.ts#L43">record.ts:43</a></li>
233+
<li>Defined in <a href="https://github.com/hexonet/node-sdk/blob/32e9f91/src/record.ts#L43">record.ts:43</a></li>
234234
</ul>
235235
</aside>
236236
<div class="tsd-comment tsd-typography">

0 commit comments

Comments
 (0)