Skip to content
This repository was archived by the owner on Oct 12, 2024. It is now read-only.

Commit d613eed

Browse files
committed
refactor: upgrade to angular11
1 parent 417ffa8 commit d613eed

File tree

6 files changed

+17542
-14978
lines changed

6 files changed

+17542
-14978
lines changed

README.md

Lines changed: 22 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A better [Socket.IO](https://socket.io) module for [Angular](https://angular.io)
1717

1818
## Prerequisites
1919

20-
- [Angular](https://angular.io) >= 10.0.0
20+
- [Angular](https://angular.io) >= 11.0.0
2121
- [Socket.IO](https://socket.io) >= 4.0.0
2222

2323

@@ -53,12 +53,12 @@ Getting Socketio Service via DI:
5353

5454
```ts
5555
import { Injectable } from '@angular/core';
56-
import { Socketio } from 'ngx-socketio2';
56+
import { Socket } from 'ngx-socketio2';
5757
import { tap } from 'rxjs/operators';
5858

5959
@Injectable()
6060
export class YourService {
61-
constructor(private socket: Socketio) {}
61+
constructor(private socket: Socket) {}
6262

6363
send(msg: string) {
6464
this.socket.emit('message', msg);
@@ -85,17 +85,17 @@ In this case, we no longer need the `SocketioModule`. Instead, use a new service
8585

8686
```ts
8787
import { Injectable } from '@angular/core';
88-
import { Socketio } from 'ngx-socketio2';
88+
import { Socket } from 'ngx-socketio2';
8989

9090
@Injectable()
91-
export class Socketio1Service extends Socketio {
91+
export class Socket1Service extends Socket {
9292
constructor() {
9393
super({ url: 'http://localhost:4200' })
9494
}
9595
}
9696

9797
@Injectable()
98-
export class Socketio2Service extends Socketio {
98+
export class Socket2Service extends Socket {
9999
constructor() {
100100
super({ url: 'http://localhost:6200' })
101101
}
@@ -107,31 +107,27 @@ export class Socketio2Service extends Socketio {
107107
// ...
108108
providers: [
109109
// ...
110-
Socketio1Service,
111-
Socketio2Service
110+
Socket1Service,
111+
Socket2Service
112112
]
113113
})
114114
export class YourModule { }
115115
```
116116

117117
## API
118118

119-
| Class | API | Description |
120-
| ----- | --- | ----------- |
121-
| SocketioModule | .forRoot({ url[, options] }) | [https://socket.io/docs/v4/client-api/#iourl](https://socket.io/docs/v4/client-api/#iourl) |
122-
| Socketio | .id | [https://socket.io/docs/v4/client-api/#socketid](https://socket.io/docs/v4/client-api/#socketid) |
123-
| | .connected | [https://socket.io/docs/v4/client-api/#socketconnected](https://socket.io/docs/v4/client-api/#socketconnected) |
124-
| | .disconnected | [https://socket.io/docs/v4/client-api/#socketdisconnected](https://socket.io/docs/v4/client-api/#socketdisconnected) |
125-
| | .io | [https://socket.io/docs/v4/client-api/#socketio](https://socket.io/docs/v4/client-api/#socketio) |
126-
| | .auth | [https://socket.io/docs/v4/client-options/#auth](https://socket.io/docs/v4/client-options/#auth) |
127-
| | .connect() | [https://socket.io/docs/v4/client-api/#socketconnect](https://socket.io/docs/v4/client-api/#socketconnect) |
128-
| | .disconnect() | [https://socket.io/docs/v4/client-api/#socketdisconnect](https://socket.io/docs/v4/client-api/#socketdisconnect) |
129-
| | .send([...args][, ack]) | [https://socket.io/docs/v4/client-api/#socketsendargs](https://socket.io/docs/v4/client-api/#socketsendargs) |
130-
| | .emit(eventName[, ...args][, ack]) | [https://socket.io/docs/v4/client-api/#socketemiteventname-args](https://socket.io/docs/v4/client-api/#socketemiteventname-args) |
119+
| Class | API | Description |
120+
| -------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
121+
| SocketioModule | .forRoot({ url[, options] }) | [https://socket.io/docs/v4/client-api/#iourl](https://socket.io/docs/v4/client-api/#iourl) |
122+
| Socket | .id | [https://socket.io/docs/v4/client-api/#socketid](https://socket.io/docs/v4/client-api/#socketid) |
123+
| | .connected | [https://socket.io/docs/v4/client-api/#socketconnected](https://socket.io/docs/v4/client-api/#socketconnected) |
124+
| | .disconnected | [https://socket.io/docs/v4/client-api/#socketdisconnected](https://socket.io/docs/v4/client-api/#socketdisconnected) |
125+
| | .io | [https://socket.io/docs/v4/client-api/#socketio](https://socket.io/docs/v4/client-api/#socketio) |
126+
| | .auth | [https://socket.io/docs/v4/client-options/#auth](https://socket.io/docs/v4/client-options/#auth) |
127+
| | .connect() | [https://socket.io/docs/v4/client-api/#socketconnect](https://socket.io/docs/v4/client-api/#socketconnect) |
128+
| | .disconnect() | [https://socket.io/docs/v4/client-api/#socketdisconnect](https://socket.io/docs/v4/client-api/#socketdisconnect) |
129+
| | .send([...args][, ack]) | [https://socket.io/docs/v4/client-api/#socketsendargs](https://socket.io/docs/v4/client-api/#socketsendargs) |
130+
| | .emit(eventName[, ...args][, ack]) | [https://socket.io/docs/v4/client-api/#socketemiteventname-args](https://socket.io/docs/v4/client-api/#socketemiteventname-args) |
131131
| | .on(eventName) | [https://socket.io/docs/v4/client-api/#socketoneventname-callback](https://socket.io/docs/v4/client-api/#socketoneventname-callback) |
132-
| | .once(eventName) | Similar to `.on(eventName)`, but only responds once. |
133-
| | .compress(compress) | [https://socket.io/docs/v4/client-api/#socketcompressvalue](https://socket.io/docs/v4/client-api/#socketcompressvalue) |
134-
135-
## Stats
136-
137-
![Stats](https://repobeats.axiom.co/api/embed/59f75da44a2887a253ee62d72389ee17ee6a8563.svg)
132+
| | .once(eventName) | Similar to `.on(eventName)`, but only responds once. |
133+
| | .compress(compress) | [https://socket.io/docs/v4/client-api/#socketcompressvalue](https://socket.io/docs/v4/client-api/#socketcompressvalue) |

angular.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@
7979
"optimization": true,
8080
"outputHashing": "all",
8181
"sourceMap": false,
82-
"extractCss": true,
8382
"namedChunks": false,
8483
"extractLicenses": true,
8584
"vendorChunk": false,

0 commit comments

Comments
 (0)