Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iamgyz/use-socket.io-client

https://www.npmjs.com/package/use-socket.io-client
https://github.com/iamgyz/use-socket.io-client

react react-hooks reactjs

Last synced: 11 days ago
JSON representation

https://www.npmjs.com/package/use-socket.io-client

Awesome Lists containing this project

README

        

# use-socket.io-client
[![Build Status](https://travis-ci.org/iamgyz/use-socket.io-client.svg?branch=master)](https://travis-ci.org/iamgyz/use-socket.io-client)

React(^16.8.0) hook for socket.io-client, manipulate socket.io client without any side effect.

```javascript
//In legacy, you would write like this:
import io from 'socket.io-client';
socket = io('ws://host:port');

//Now, you could easily write this inside the body of a function component:
import useSocket from 'use-socket.io-client';
const [socket] = useSocket('ws://host:port')
```

## Installation

```
$ npm i use-socket.io-client
```

## Example
```javascript
import useSocket from 'use-socket.io-client';

//You can treat "useSocket" as "io"
const [socket] = useSocket('ws://localhost:8080',{
autoConnect: false,
//any other options
});

//connect socket
socket.connect();

//add event
socket.on('message',(text)=>{
console.log(text);
});

//emit
socket.emit('message','this is demo..');
```