jd_platform_sdk 0.3.9 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/readme.md +55 -55
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,55 +1,55 @@
|
|
|
1
|
-
## JdSDK
|
|
2
|
-
Collection of useful utilities and model classes for JoyDash Platforms (PlayRivals, AppRivals, DeskProX, KaraokeProX)
|
|
3
|
-
|
|
4
|
-
## Creating a new project
|
|
5
|
-
````
|
|
6
|
-
npm install typescript --save-dev
|
|
7
|
-
````
|
|
8
|
-
|
|
9
|
-
### Requirements
|
|
10
|
-
````
|
|
11
|
-
npm install crypto-js
|
|
12
|
-
npm install --save-dev @types/crypto-js
|
|
13
|
-
````
|
|
14
|
-
|
|
15
|
-
### Configure typescript
|
|
16
|
-
````
|
|
17
|
-
{
|
|
18
|
-
"compilerOptions": {
|
|
19
|
-
"target": "ES6",
|
|
20
|
-
"module": "ESNext",
|
|
21
|
-
"declaration": true,
|
|
22
|
-
"outDir": "./dist",
|
|
23
|
-
"strict": true
|
|
24
|
-
},
|
|
25
|
-
|
|
26
|
-
"include": ["src/**/*.ts"]
|
|
27
|
-
}
|
|
28
|
-
````
|
|
29
|
-
|
|
30
|
-
### Unit Tests
|
|
31
|
-
````
|
|
32
|
-
npx vitest
|
|
33
|
-
````
|
|
34
|
-
|
|
35
|
-
### Individual file tests
|
|
36
|
-
````
|
|
37
|
-
npm install ts-node typescript --save-dev
|
|
38
|
-
npm i -D tsx
|
|
39
|
-
|
|
40
|
-
npx ts-node .\test-script.ts
|
|
41
|
-
node --import=tsx .\test-script.ts
|
|
42
|
-
````
|
|
43
|
-
|
|
44
|
-
### Linking project
|
|
45
|
-
````
|
|
46
|
-
#This step is important for newly created server, otherwise, the module will be missing
|
|
47
|
-
cd /path/to/my-utils-package
|
|
48
|
-
npm link
|
|
49
|
-
````
|
|
50
|
-
|
|
51
|
-
### Publishing
|
|
52
|
-
````
|
|
53
|
-
npm login
|
|
54
|
-
npm publish
|
|
55
|
-
````
|
|
1
|
+
## JdSDK
|
|
2
|
+
Collection of useful utilities and model classes for JoyDash Platforms (PlayRivals, AppRivals, DeskProX, KaraokeProX)
|
|
3
|
+
|
|
4
|
+
## Creating a new project
|
|
5
|
+
````
|
|
6
|
+
npm install typescript --save-dev
|
|
7
|
+
````
|
|
8
|
+
|
|
9
|
+
### Requirements
|
|
10
|
+
````
|
|
11
|
+
npm install crypto-js
|
|
12
|
+
npm install --save-dev @types/crypto-js
|
|
13
|
+
````
|
|
14
|
+
|
|
15
|
+
### Configure typescript
|
|
16
|
+
````
|
|
17
|
+
{
|
|
18
|
+
"compilerOptions": {
|
|
19
|
+
"target": "ES6",
|
|
20
|
+
"module": "ESNext",
|
|
21
|
+
"declaration": true,
|
|
22
|
+
"outDir": "./dist",
|
|
23
|
+
"strict": true
|
|
24
|
+
},
|
|
25
|
+
|
|
26
|
+
"include": ["src/**/*.ts"]
|
|
27
|
+
}
|
|
28
|
+
````
|
|
29
|
+
|
|
30
|
+
### Unit Tests
|
|
31
|
+
````
|
|
32
|
+
npx vitest
|
|
33
|
+
````
|
|
34
|
+
|
|
35
|
+
### Individual file tests
|
|
36
|
+
````
|
|
37
|
+
npm install ts-node typescript --save-dev
|
|
38
|
+
npm i -D tsx
|
|
39
|
+
|
|
40
|
+
npx ts-node .\test-script.ts
|
|
41
|
+
node --import=tsx .\test-script.ts
|
|
42
|
+
````
|
|
43
|
+
|
|
44
|
+
### Linking project
|
|
45
|
+
````
|
|
46
|
+
#This step is important for newly created server, otherwise, the module will be missing
|
|
47
|
+
cd /path/to/my-utils-package
|
|
48
|
+
npm link
|
|
49
|
+
````
|
|
50
|
+
|
|
51
|
+
### Publishing
|
|
52
|
+
````
|
|
53
|
+
npm login
|
|
54
|
+
npm publish
|
|
55
|
+
````
|