545563e776
- Complete NestJS TypeScript implementation with WebSocket support - Direct messaging (DM) and group chat functionality - End-to-end encryption with AES encryption and key pairs - Media file support (images, videos, audio, documents) up to 100MB - Push notifications with Firebase Cloud Messaging integration - Mention alerts and real-time typing indicators - User authentication with JWT and Passport - SQLite database with TypeORM entities and relationships - Comprehensive API documentation with Swagger/OpenAPI - File upload handling with secure access control - Online/offline status tracking and presence management - Message editing, deletion, and reply functionality - Notification management with automatic cleanup - Health check endpoint for monitoring - CORS configuration for cross-origin requests - Environment-based configuration management - Structured for Flutter SDK integration Features implemented: ✅ Real-time messaging with Socket.IO ✅ User registration and authentication ✅ Direct messages and group chats ✅ Media file uploads and management ✅ End-to-end encryption ✅ Push notifications ✅ Mention alerts ✅ Typing indicators ✅ Message read receipts ✅ Online status tracking ✅ File access control ✅ Comprehensive API documentation Ready for Flutter SDK development and production deployment.
75 lines
1.3 KiB
Markdown
75 lines
1.3 KiB
Markdown
# Emitter [](https://travis-ci.org/component/emitter)
|
|
|
|
Event emitter component.
|
|
|
|
## Installation
|
|
|
|
```
|
|
$ component install component/emitter
|
|
```
|
|
|
|
## API
|
|
|
|
### Emitter(obj)
|
|
|
|
The `Emitter` may also be used as a mixin. For example
|
|
a "plain" object may become an emitter, or you may
|
|
extend an existing prototype.
|
|
|
|
As an `Emitter` instance:
|
|
|
|
```js
|
|
var Emitter = require('emitter');
|
|
var emitter = new Emitter;
|
|
emitter.emit('something');
|
|
```
|
|
|
|
As a mixin:
|
|
|
|
```js
|
|
var Emitter = require('emitter');
|
|
var user = { name: 'tobi' };
|
|
Emitter(user);
|
|
|
|
user.emit('im a user');
|
|
```
|
|
|
|
As a prototype mixin:
|
|
|
|
```js
|
|
var Emitter = require('emitter');
|
|
Emitter(User.prototype);
|
|
```
|
|
|
|
### Emitter#on(event, fn)
|
|
|
|
Register an `event` handler `fn`.
|
|
|
|
### Emitter#once(event, fn)
|
|
|
|
Register a single-shot `event` handler `fn`,
|
|
removed immediately after it is invoked the
|
|
first time.
|
|
|
|
### Emitter#off(event, fn)
|
|
|
|
* Pass `event` and `fn` to remove a listener.
|
|
* Pass `event` to remove all listeners on that event.
|
|
* Pass nothing to remove all listeners on all events.
|
|
|
|
### Emitter#emit(event, ...)
|
|
|
|
Emit an `event` with variable option args.
|
|
|
|
### Emitter#listeners(event)
|
|
|
|
Return an array of callbacks, or an empty array.
|
|
|
|
### Emitter#hasListeners(event)
|
|
|
|
Check if this emitter has `event` handlers.
|
|
|
|
## License
|
|
|
|
MIT
|