@@ -17,7 +17,7 @@ A better [Socket.IO](https://socket.io) module for [Angular](https://angular.io)
17
17
18
18
## Prerequisites
19
19
20
- - [ Angular] ( https://angular.io ) >= 10 .0.0
20
+ - [ Angular] ( https://angular.io ) >= 11 .0.0
21
21
- [ Socket.IO] ( https://socket.io ) >= 4.0.0
22
22
23
23
@@ -53,12 +53,12 @@ Getting Socketio Service via DI:
53
53
54
54
``` ts
55
55
import { Injectable } from ' @angular/core' ;
56
- import { Socketio } from ' ngx-socketio2' ;
56
+ import { Socket } from ' ngx-socketio2' ;
57
57
import { tap } from ' rxjs/operators' ;
58
58
59
59
@Injectable ()
60
60
export class YourService {
61
- constructor (private socket : Socketio ) {}
61
+ constructor (private socket : Socket ) {}
62
62
63
63
send(msg : string ) {
64
64
this .socket .emit (' message' , msg );
@@ -85,17 +85,17 @@ In this case, we no longer need the `SocketioModule`. Instead, use a new service
85
85
86
86
``` ts
87
87
import { Injectable } from ' @angular/core' ;
88
- import { Socketio } from ' ngx-socketio2' ;
88
+ import { Socket } from ' ngx-socketio2' ;
89
89
90
90
@Injectable ()
91
- export class Socketio1Service extends Socketio {
91
+ export class Socket1Service extends Socket {
92
92
constructor () {
93
93
super ({ url: ' http://localhost:4200' })
94
94
}
95
95
}
96
96
97
97
@Injectable ()
98
- export class Socketio2Service extends Socketio {
98
+ export class Socket2Service extends Socket {
99
99
constructor () {
100
100
super ({ url: ' http://localhost:6200' })
101
101
}
@@ -107,31 +107,27 @@ export class Socketio2Service extends Socketio {
107
107
// ...
108
108
providers: [
109
109
// ...
110
- Socketio1Service ,
111
- Socketio2Service
110
+ Socket1Service ,
111
+ Socket2Service
112
112
]
113
113
})
114
114
export class YourModule { }
115
115
```
116
116
117
117
## API
118
118
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 ) |
131
131
| | .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 ) |
0 commit comments