Skip to content

Commit

Permalink
chore: update package name (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
bytemain authored May 14, 2024
1 parent 3fc6df5 commit e622db9
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 22 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ WebSocket that will automatically reconnect if the connection is closed.
## Install

```bash
npm install --save @bytemain/reconnecting-websocket
npm install --save @opensumi/reconnecting-websocket
```

## Usage
Expand All @@ -33,7 +33,7 @@ request :)
### Simple usage

```javascript
import ReconnectingWebSocket from '@bytemain/reconnecting-websocket';
import ReconnectingWebSocket from '@opensumi/reconnecting-websocket';

const rws = new ReconnectingWebSocket('ws://my.site.com');

Expand All @@ -51,7 +51,7 @@ The `url` parameter will be resolved before connecting, possible types:
- `() => Promise<string>`

```javascript
import ReconnectingWebSocket from '@bytemain/reconnecting-websocket';
import ReconnectingWebSocket from '@opensumi/reconnecting-websocket';

const urls = ['ws://my.site.com', 'ws://your.site.com', 'ws://their.site.com'];
let urlIndex = 0;
Expand All @@ -63,7 +63,7 @@ const rws = new ReconnectingWebSocket(urlProvider);
```

```javascript
import ReconnectingWebSocket from '@bytemain/reconnecting-websocket';
import ReconnectingWebSocket from '@opensumi/reconnecting-websocket';

// async url provider
const urlProvider = async () => {
Expand All @@ -79,7 +79,7 @@ const rws = new ReconnectingWebSocket(urlProvider);
#### Sample with custom options

```javascript
import ReconnectingWebSocket from '@bytemain/reconnecting-websocket';
import ReconnectingWebSocket from '@opensumi/reconnecting-websocket';
import WS from 'ws';

const options = {
Expand Down Expand Up @@ -175,8 +175,10 @@ CLOSED 3 The connection is closed or couldn't be opened.

MIT

This project was forked from [pladaria/reconnecting-websocket](https://github.com/pladaria/reconnecting-websocket).
This project was forked from
[pladaria/reconnecting-websocket](https://github.com/pladaria/reconnecting-websocket).

Because it seems that the original project is no longer maintained, I decided to fork it and continue to maintain it.
Because it seems that the original project is no longer maintained, I decided to fork it and
continue to maintain it.

Thanks all original contributors for their work.
14 changes: 7 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 6 additions & 7 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "@bytemain/reconnecting-websocket",
"name": "@opensumi/reconnecting-websocket",
"version": "4.4.0",
"description": "Reconnecting WebSocket",
"main": "./dist/reconnecting-websocket-cjs.js",
Expand All @@ -25,7 +25,6 @@
"forever",
"automatic"
],
"author": "bytemain <[email protected]>",
"files": [
"dist/*"
],
Expand All @@ -43,8 +42,8 @@
"lint-staged": "^7.3.0",
"opn-cli": "^3.1.0",
"prettier": "^1.19.1",
"rollup": "^0.66.6",
"rollup-plugin-typescript2": "^0.23.0",
"rollup": "0.68.0",
"rollup-plugin-typescript2": "0.23.0",
"ts-jest": "^25.2.0",
"tslib": "^1.10.0",
"tslint": "^5.20.1",
Expand All @@ -58,16 +57,16 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/bytemain/reconnecting-websocket.git"
"url": "git+https://github.com/opensumi/reconnecting-websocket.git"
},
"bugs": {
"url": "https://github.com/bytemain/reconnecting-websocket/issues"
"url": "https://github.com/opensumi/reconnecting-websocket/issues"
},
"publishConfig": {
"registry": "https://registry.npmjs.org",
"access": "public"
},
"homepage": "https://github.com/bytemain/reconnecting-websocket#readme",
"homepage": "https://github.com/opensumi/reconnecting-websocket#readme",
"lint-staged": {
"linters": {
"*.{js,md,ts}": [
Expand Down
2 changes: 1 addition & 1 deletion reconnecting-websocket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
* Reconnecting WebSocket
* by Pedro Ladaria <[email protected]>
* https://github.com/pladaria/reconnecting-websocket
* https://github.com/bytemain/reconnecting-websocket
* https://github.com/opensumi/reconnecting-websocket
* License MIT
*/

Expand Down

0 comments on commit e622db9

Please sign in to comment.