Skip to content

Commit ad76df3

Browse files
GiwiGiwi
committed
Update doc and changelog
1 parent 36f499e commit ad76df3

File tree

11 files changed

+412
-71
lines changed

11 files changed

+412
-71
lines changed

‎CHANGELOG.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
Warp 10 js lib
2+
---
3+
4+
## v1.1.4
5+
6+
> + 2023/10/23 | v1.1.4
7+
8+
## v1.1.3
9+
10+
> + 2023/10/23 | v1.1.3
11+
> + 2023/10/23 | doc and lints
12+
> + 2023/10/23 | doc and lints
13+
> + 2023/10/23 | doc and lints
14+
> + 2023/10/23 | doc and lints
15+
> + 2023/10/23 | doc and lints
16+
> + 2023/10/23 | doc and lints
17+
> + 2022/07/13 | Bump ansi-regex from 3.0.0 to 3.0.1
18+
> + 2021/06/12 | Bump glob-parent from 5.1.1 to 5.1.2
19+
20+
## v1.1.2
21+
22+
> + 2021/05/31 | v1.1.2
23+
24+
## v1.1.0
25+
26+
> + 2021/05/27 | v1.1.0
27+
> + 2021/05/27 | clean old deps
28+
> + 2021/01/05 | build fix
29+
30+
## v1.0.14
31+
32+
> + 2021/01/05 | v1.0.14
33+
34+
## v1.0.13
35+
36+
> + 2021/01/05 | v1.0.13
37+
38+
## v1.0.12
39+
40+
> + 2021/01/05 | v1.0.12
41+
42+
## v1.0.11
43+
44+
> + 2021/01/05 | v1.0.11
45+
> + 2021/01/05 | dependencies update, dayjs migration, enhanced unit tests
46+
> + 2020/07/14 | publish workflow
47+
> + 2020/07/14 | publish
48+
> + 2020/07/14 | fix es5 import
49+
50+
## v1.0.7
51+
52+
> + 2020/04/29 | v1.0.7
53+
54+
## v1.0.6
55+
56+
> + 2020/04/29 | v1.0.6
57+
> + 2020/04/29 | fix export
58+
> + 2020/03/31 | fix export
59+
60+
## v1.0.5
61+
62+
> + 2020/03/31 | v1.0.5
63+
64+
## v1.0.4
65+
66+
> + 2020/03/31 | v1.0.4
67+
> + 2020/03/31 | fix export
68+
69+

‎changelog.js‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
#!/usr/bin/env node
2+
const {execSync} = require('child_process');
3+
const semverSort = require('semver-sort');
4+
let repo = 'https://github.com/senx/node-warp10';
5+
let md =
6+
`Warp 10 js lib
7+
---
8+
9+
`;
10+
11+
let tagList = execSync('git tag -l --sort=-v:refname | head -n 1000');
12+
tagList = tagList.toString().split('\n').filter(i => i !== '');
13+
tagList = semverSort.desc(tagList);
14+
let lastTag = tagList[0];
15+
tagList = tagList.slice(1, -1);
16+
tagList.forEach(tag => {
17+
md += `## ${lastTag}
18+
19+
`;
20+
execSync(`git log --no-merges --date=iso --format="> + ts%ct | %s %N" ${tag}..${lastTag}`)
21+
.toString().split('\n').forEach(l => {
22+
let timestamp = /ts([0-9]+)/.exec(l);
23+
if (timestamp) {
24+
l = l.replace('ts' + timestamp[1], new Date(timestamp[1] * 1000).toISOString().split('T')[0].replace(/\-/gi, '/'));
25+
}
26+
let issue = /#([0-9]+)/.exec(l);
27+
if (issue) {
28+
l = l.replace('#' + issue[1], `[#${issue[1]}](${repo}/issues/${issue[1]})`);
29+
}
30+
md += l + '\n';
31+
});
32+
lastTag = tag;
33+
34+
});
35+
console.log(md);

‎docs/README.md‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Node.js library that helps to interact with Warp 10.
1111
## Installation
1212

1313
npm i @senx/warp10
14+
yarn add @senx/warp10
1415

1516
## Dates and formats
1617

@@ -20,34 +21,38 @@ Available fetch formats:
2021

2122
- text
2223
- fulltext
23-
- json (default)
24+
- json
2425
- tsv
2526
- fulltsv
2627
- pack
2728
- raw
29+
- formatted (a json format, default)
2830

2931
## Usage sample
3032

3133
```javascript
3234
import {Warp10} from "@senx/warp10";
33-
import * as moment from 'moment';
35+
import dayjs from "dayjs";
36+
import utc from "dayjs/plugin/utc";
37+
dayjs.extend(utc);
3438

3539
const writeToken = 'xxxxxx';
3640
const deleteToken = 'xxxxxx';
3741
const readToken = 'xxxx';
38-
const w10 = new Warp10('https://sandbox.senx.io');
42+
const w10 = new Warp10().endpoint('https://sandbox.senx.io');
43+
// or const w10 = new Warp10({endpoint: 'https://sandbox.senx.io'});
3944

4045
const test = async () => {
4146

4247
// WarpScript execution
4348
console.log(await w10.exec('2 2 +'));
4449

4550
// fetch raw data between 2 dates
46-
console.log(await w10.fetch(readToken, '~io.warp10.*', {}, '2019-11-11T12:34:43.388409Z', '2019-11-21T12:34:43.388409Z', 'json'));
51+
console.log(await w10.fetch(readToken, '~io.warp10.*', {}, '2019-11-11T12:34:43.388409Z', dayjs().toISOString()));
4752

4853
// insert data points
4954
console.log(await w10.update(writeToken, [
50-
{timestamp: moment.utc().valueOf() * 1000, className: 'io.warp10.test', labels: {key: 'value'}, value: 54},
55+
{timestamp: dayjs().utc().valueOf() * 1000, className: 'io.warp10.test', labels: {key: 'value'}, value: 54},
5156
'1380475081000000// io.warp10.test{key=value} T',
5257
'1566893344654882/48.81:-4.147/124 io.warp10.test{key=value} [8.2 151 152 1568189745655509/40.6:-74/14 ]',
5358
]));
@@ -60,10 +65,10 @@ const test = async () => {
6065
}]));
6166

6267
// Fetch data with a time span
63-
console.log(await w10.fetch(readToken, '~.*', {}, '2019-11-21T12:34:43.388409Z', 86400000000 * 5));
68+
console.log(await w10.fetch(readToken, '~.*', {}, dayjs().toISOString(), 86400000000 * 5));
6469

6570
// delete data between 2 dates
66-
console.log(await w10.delete(deleteToken, '~io.warp10.test*', {key: 'value'}, '2019-11-11T12:34:43.388409Z', '2019-11-21T12:34:43.388409Z'));
71+
console.log(await w10.delete(deleteToken, '~io.warp10.test*', {key: 'value'}, '2019-11-11T12:34:43.388409Z', dayjs().toISOString()));
6772

6873
// delete all
6974
console.log(await w10.delete(deleteToken, '~io.warp10.test*', {key: 'value'}, '', '', true));

‎docs/classes/DataPoint.DataPoint.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434

3535
#### Defined in
3636

37-
[DataPoint.ts:22](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L22)
37+
[DataPoint.ts:21](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L21)
3838

3939
___
4040

@@ -44,7 +44,7 @@ ___
4444

4545
#### Defined in
4646

47-
[DataPoint.ts:21](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L21)
47+
[DataPoint.ts:20](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L20)
4848

4949
___
5050

@@ -58,7 +58,7 @@ ___
5858

5959
#### Defined in
6060

61-
[DataPoint.ts:24](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L24)
61+
[DataPoint.ts:23](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L23)
6262

6363
___
6464

@@ -68,7 +68,7 @@ ___
6868

6969
#### Defined in
7070

71-
[DataPoint.ts:19](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L19)
71+
[DataPoint.ts:18](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L18)
7272

7373
___
7474

@@ -78,7 +78,7 @@ ___
7878

7979
#### Defined in
8080

81-
[DataPoint.ts:20](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L20)
81+
[DataPoint.ts:19](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L19)
8282

8383
___
8484

@@ -88,7 +88,7 @@ ___
8888

8989
#### Defined in
9090

91-
[DataPoint.ts:18](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L18)
91+
[DataPoint.ts:17](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L17)
9292

9393
___
9494

@@ -98,4 +98,4 @@ ___
9898

9999
#### Defined in
100100

101-
[DataPoint.ts:23](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/DataPoint.ts#L23)
101+
[DataPoint.ts:22](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/DataPoint.ts#L22)

‎docs/classes/logger.Logger.md‎

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414

1515
- [className](logger.Logger.md#classname)
1616
- [isDebug](logger.Logger.md#isdebug)
17+
- [silent](logger.Logger.md#silent)
1718

1819
### Methods
1920

@@ -27,18 +28,19 @@
2728

2829
### constructor
2930

30-
• **new Logger**(`className`, `isDebug?`)
31+
• **new Logger**(`className`, `isDebug?`, `silent?`)
3132

3233
#### Parameters
3334

3435
| Name | Type | Default value |
3536
| :------ | :------ | :------ |
3637
| `className` | `any` | `undefined` |
3738
| `isDebug` | `boolean` | `false` |
39+
| `silent` | `boolean` | `false` |
3840

3941
#### Defined in
4042

41-
[logger.ts:24](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L24)
43+
[logger.ts:25](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L25)
4244

4345
## Properties
4446

@@ -48,7 +50,7 @@
4850

4951
#### Defined in
5052

51-
[logger.ts:21](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L21)
53+
[logger.ts:21](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L21)
5254

5355
___
5456

@@ -58,7 +60,17 @@ ___
5860

5961
#### Defined in
6062

61-
[logger.ts:22](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L22)
63+
[logger.ts:22](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L22)
64+
65+
___
66+
67+
### silent
68+
69+
• **silent**: `boolean` = `false`
70+
71+
#### Defined in
72+
73+
[logger.ts:23](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L23)
6274

6375
## Methods
6476

@@ -79,7 +91,7 @@ ___
7991

8092
#### Defined in
8193

82-
[logger.ts:60](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L60)
94+
[logger.ts:64](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L64)
8395

8496
___
8597

@@ -100,7 +112,7 @@ ___
100112

101113
#### Defined in
102114

103-
[logger.ts:64](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L64)
115+
[logger.ts:68](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L68)
104116

105117
___
106118

@@ -121,7 +133,7 @@ ___
121133

122134
#### Defined in
123135

124-
[logger.ts:72](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L72)
136+
[logger.ts:76](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L76)
125137

126138
___
127139

@@ -143,7 +155,7 @@ ___
143155

144156
#### Defined in
145157

146-
[logger.ts:29](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L29)
158+
[logger.ts:31](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L31)
147159

148160
___
149161

@@ -164,4 +176,4 @@ ___
164176

165177
#### Defined in
166178

167-
[logger.ts:68](https://gitlab.com/senx/node-warp10/-/blob/0dd4818/src/lib/logger.ts#L68)
179+
[logger.ts:72](https://gitlab.com/senx/node-warp10/-/blob/36f499e/src/lib/logger.ts#L72)

0 commit comments

Comments
 (0)