Skip to content

Commit 11fefc0

Browse files
committed
docs: add connectionMap to readme
1 parent 3953941 commit 11fefc0

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,15 @@ Here's an example of how to use it:
135135
```jsx
136136
import { useWebsocket, WEBSOCKET_READY_STATE } from 'use-awesome-websocket';
137137

138+
139+
const connectionMap = {
140+
[WEBSOCKET_READY_STATE.CONNECTING]: 'Connecting',
141+
[WEBSOCKET_READY_STATE.OPEN]: 'Open',
142+
[WEBSOCKET_READY_STATE.CLOSING]: 'Closing',
143+
[WEBSOCKET_READY_STATE.CLOSED]: 'Closed',
144+
[WEBSOCKET_READY_STATE.UNINSTANTIATED]: 'Uninstantiated',
145+
};
146+
138147
function YourComponent() {
139148
const { readyState, sendData, lastData } = useWebSocket<string, string>({
140149
url: 'wss://your-websocket-url',

0 commit comments

Comments
 (0)