Skip to content

Commit f73b4a7

Browse files
CISCCISC
committed
Modernize example.
1 parent 2db387a commit f73b4a7

File tree

3 files changed

+77
-53
lines changed

3 files changed

+77
-53
lines changed

‎README.md‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -12,26 +12,34 @@ This module is loosely modelled after the scws2 Python module, supporting the 2.
1212
## Example usage (set DEBUG=scjs for debug output):
1313

1414
```js
15-
var scjs = require('scjs');
16-
17-
var baseurl = "http://localhost/ContentManager";
18-
var username = "user";
19-
var password = "pass";
20-
var cm = new scjs.ConManager(baseurl);
21-
cm.login(username, password).then((resp) => {
22-
cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' }).then((players) => {
15+
const { ConManager } = require('scjs');
16+
17+
const baseurl = "http://localhost/ContentManager";
18+
const username = "user";
19+
const password = "pass";
20+
const cm = new ConManager(baseurl);
21+
22+
(async () => {
23+
const resp = await cm.login(username, password);
24+
25+
try {
26+
const players = await cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' });
2327
console.log(players.list);
24-
});
25-
cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' }).then((media) => {
26-
var p = Promise.resolve();
27-
media.list.forEach((item) => {
28-
p = p.then(cm.download(item.downloadPath, item.name));
29-
});
30-
});
31-
cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg').then((item) => {
28+
29+
const media = await cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' });
30+
31+
let items = [];
32+
for (const item of media.list) {
33+
items.push(cm.download(item.downloadPath, item.name));
34+
}
35+
await Promise.all(items);
36+
37+
const item = await cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg');
3238
console.log(item);
33-
});
34-
}).catch((e) => {
39+
} finally {
40+
await cm.post('auth/logout');
41+
}
42+
})().catch((e) => {
3543
console.log(e);
3644
});
3745
```

‎index.d.ts‎

Lines changed: 26 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,26 +7,34 @@ declare module scjs {
77
*
88
* Example usage (set DEBUG=scjs for debug output):
99
*
10-
* var scjs = require('scjs');
11-
*
12-
* var baseurl = "http://localhost/ContentManager";
13-
* var username = "user";
14-
* var password = "pass";
15-
* var cm = new scjs.ConManager(baseurl);
16-
* cm.login(username, password).then((resp) => {
17-
* cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' }).then((players) => {
10+
* const { ConManager } = require('scjs');
11+
*
12+
* const baseurl = "http://localhost/ContentManager";
13+
* const username = "user";
14+
* const password = "pass";
15+
* const cm = new ConManager(baseurl);
16+
*
17+
* (async () => {
18+
* const resp = await cm.login(username, password);
19+
*
20+
* try {
21+
* const players = await cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' });
1822
* console.log(players.list);
19-
* });
20-
* cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' }).then((media) => {
21-
* var p = Promise.resolve();
22-
* media.list.forEach((item) => {
23-
* p = p.then(cm.download(item.downloadPath, item.name));
24-
* });
25-
* });
26-
* cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg').then((item) => {
23+
*
24+
* const media = await cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' });
25+
*
26+
* let items = [];
27+
* for (const item of media.list) {
28+
* items.push(cm.download(item.downloadPath, item.name));
29+
* }
30+
* await Promise.all(items);
31+
*
32+
* const item = await cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg');
2733
* console.log(item);
28-
* });
29-
* }).catch((e) => {
34+
* } finally {
35+
* await cm.post('auth/logout');
36+
* }
37+
* })().catch((e) => {
3038
* console.log(e);
3139
* });
3240
*

‎index.js‎

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -40,26 +40,34 @@ const querystring = require('querystring');
4040
*
4141
* Example usage (set DEBUG=scjs for debug output):
4242
*
43-
* var scjs = require('scjs');
43+
* const { ConManager } = require('scjs');
4444
*
45-
* var baseurl = "http://localhost/ContentManager";
46-
* var username = "user";
47-
* var password = "pass";
48-
* var cm = new scjs.ConManager(baseurl);
49-
* cm.login(username, password).then((resp) => {
50-
* cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' }).then((players) => {
45+
* const baseurl = "http://localhost/ContentManager";
46+
* const username = "user";
47+
* const password = "pass";
48+
* const cm = new ConManager(baseurl);
49+
*
50+
* (async () => {
51+
* const resp = await cm.login(username, password);
52+
*
53+
* try {
54+
* const players = await cm.get('players', { 'limit': 0, 'offset': 0, 'fields': 'id,name,enabled,active,type' });
5155
* console.log(players.list);
52-
* });
53-
* cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' }).then((media) => {
54-
* var p = Promise.resolve();
55-
* media.list.forEach((item) => {
56-
* p = p.then(cm.download(item.downloadPath, item.name));
57-
* });
58-
* });
59-
* cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg').then((item) => {
56+
*
57+
* const media = await cm.get('media', { 'limit': 10, 'filters': '{"type":{"values":["IMAGE"]}}' });
58+
*
59+
* let items = [];
60+
* for (const item of media.list) {
61+
* items.push(cm.download(item.downloadPath, item.name));
62+
* }
63+
* await Promise.all(items);
64+
*
65+
* const item = await cm.upload('LocalFolder/MyPicture.jpg', 'RemoteFolder/MyPicture.jpg');
6066
* console.log(item);
61-
* });
62-
* }).catch((e) => {
67+
* } finally {
68+
* await cm.post('auth/logout');
69+
* }
70+
* })().catch((e) => {
6371
* console.log(e);
6472
* });
6573
*

0 commit comments

Comments
 (0)