bloxd.io.d.ts 2.0.1 → 2.1.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 +48 -1
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -1,3 +1,50 @@
|
|
|
1
1
|
this project is not offical bloxd.io repo.
|
|
2
2
|
|
|
3
|
-
##
|
|
3
|
+
## how to use
|
|
4
|
+
|
|
5
|
+
Use `npm i bloxd.io.d.ts -D` in terminal(need node.js)
|
|
6
|
+
|
|
7
|
+
and add this option in tsconfig.json
|
|
8
|
+
|
|
9
|
+
```json
|
|
10
|
+
{
|
|
11
|
+
"compileOptions": {
|
|
12
|
+
"types": ["bloxd.io.d.ts"]
|
|
13
|
+
}
|
|
14
|
+
}
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## why use this
|
|
18
|
+
|
|
19
|
+
This package include bloxd.io api docment and d.ts.
|
|
20
|
+
It useful typecheck(as typescript),lint and killing typo(most important).
|
|
21
|
+
|
|
22
|
+
## how to contribute
|
|
23
|
+
|
|
24
|
+
- add more api type in src.
|
|
25
|
+
- add more docment.
|
|
26
|
+
- check code.
|
|
27
|
+
- use this package
|
|
28
|
+
|
|
29
|
+
## repo structure
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
src/
|
|
33
|
+
api-type-def/ # api functions type define
|
|
34
|
+
clientOption/ # clientOption apis define
|
|
35
|
+
clientOptions/ # clientOption function overload define(by clientOption name)
|
|
36
|
+
index.ts # marge clientOptions overload
|
|
37
|
+
|
|
38
|
+
entitySetting/ # entitySetting define
|
|
39
|
+
entitySettings/ # entitySetting function overload(by entitySetting name)
|
|
40
|
+
index.ts # marge entitySetting overload
|
|
41
|
+
mobSetting/ # making now...
|
|
42
|
+
|
|
43
|
+
normal/ # define other apis
|
|
44
|
+
|
|
45
|
+
index.ts # marge api
|
|
46
|
+
type/ # use type define e.g.`PlayerId`
|
|
47
|
+
index.ts # top level file
|
|
48
|
+
|
|
49
|
+
dist/ # d.ts result of tsc.npm package install target
|
|
50
|
+
```
|