File tree Expand file tree Collapse file tree 3 files changed +18
-5
lines changed Expand file tree Collapse file tree 3 files changed +18
-5
lines changed Original file line number Diff line number Diff line change 1
- # websocket
2
- a low level wrapper over discord's gateway and voice websocket
1
+ # Detritus Client Socket
2
+ ![ npm] ( https://img.shields.io/npm/v/detritus-client-socket?style=flat-square )
3
+
4
+ A pure-TypeScript low-level wrapper for just Discord's Gateway and Voice Connection.
5
+
6
+ - [ API Documentation] ( https://socket.detritusjs.com )
7
+ - [ npm] ( https://www.npmjs.com/package/detritus-client-socket )
3
8
4
9
## usage
5
10
``` js
Original file line number Diff line number Diff line change 12
12
"ws" : " ^7.3.1"
13
13
},
14
14
"devDependencies" : {
15
- "@types/node" : " ^12.12.51"
15
+ "@types/node" : " ^12.12.51" ,
16
+ "typedoc" : " ^0.17.8" ,
17
+ "typescript" : " ^3.9.7"
16
18
},
17
19
"peerDependencies" : {
18
20
"erlpack" : " ^0.1.3" ,
45
47
"scripts" : {
46
48
"build" : " tsc" ,
47
49
"test" : " echo \" Error: no test specified\" && exit 1" ,
48
- "prepare" : " npm run build"
50
+ "prepare" : " npm run build" ,
51
+ "typedoc" : " typedoc ./src"
49
52
},
50
53
"repository" : {
51
54
"type" : " git" ,
Original file line number Diff line number Diff line change 8
8
"strict" : true
9
9
},
10
10
"include" : [" src" ],
11
- "exclude" : [" node_modules" ]
11
+ "exclude" : [" node_modules" ],
12
+ "typedocOptions" : {
13
+ "mode" : " file" ,
14
+ "name" : " Detritus Socket Client" ,
15
+ "out" : " ./docs"
16
+ }
12
17
}
You can’t perform that action at this time.
0 commit comments