Skip to content

Commit 9f60adf

Browse files
committed
docs(readme) add Server API
1 parent c0f9167 commit 9f60adf

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,33 @@ Set new text of prompt.
6565

6666
Set focus on Console.
6767

68+
### Server API
69+
70+
**Console(options);**
71+
72+
Could be used as middleware, or for init `Console`.
73+
74+
```js
75+
**Console({
76+
server: server,/* only one should be passed: */
77+
socket: socket,/* server or socket */
78+
online: true, /* default */
79+
minify: true, /* default */
80+
prefix:'/console' /* default */
81+
})**
82+
```
83+
84+
**Console.middle(options);**
85+
86+
Middleware function if there is a need of init `socket` in another place.
87+
88+
```js
89+
**Console.middle({
90+
prefix: '/console', /* default */
91+
online: true, /* default */
92+
minify: true, /* default */
93+
})**
94+
```
6895

6996
## Use as middleware
7097

0 commit comments

Comments
 (0)