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.
71 lines
2.2 KiB
Markdown
71 lines
2.2 KiB
Markdown
# symbol-observable [](https://travis-ci.org/benlesh/symbol-observable)
|
|
|
|
> [`Symbol.observable`](https://github.com/zenparsing/es-observable) [pony/polyfill](https://ponyfill.com)
|
|
|
|
This will polyfill `Symbol.observable` if `Symbol` exists, but will not polyfill `Symbol` if it doesn't exist. Meant to be used as a "ponyfill", meaning you're meant to use the module's exported symbol value as described below. This is all done to ensure that everyone is using the same version of the symbol (or string depending on the environment), as per the nature of symbols in JavaScript.
|
|
|
|
|
|
## Install
|
|
|
|
```
|
|
$ npm install --save symbol-observable
|
|
```
|
|
|
|
|
|
## Basic Usage
|
|
|
|
```js
|
|
const symbolObservable = require('symbol-observable').default;
|
|
|
|
console.log(symbolObservable);
|
|
//=> Symbol(observable)
|
|
```
|
|
|
|
```ts
|
|
import Symbol_observable from 'symbol-observable';
|
|
|
|
console.log(Symbol_observable);
|
|
//=> Symbol(observable)
|
|
```
|
|
|
|
## Making an object "observable":
|
|
|
|
You can do something like what you see below to make any object "observable" by libraries like RxJS, XStream and Most.js.
|
|
|
|
Things to know:
|
|
|
|
1. It's best if you just use one of the above libraries.
|
|
2. If you're not, but sure you never `next`, `error` or `complete` on your observer after `error` or `complete` was called.
|
|
3. Likewise, make sure you don't `next`, `error` or `complete` after `unsubscribe` is called on the returned object.
|
|
|
|
```ts
|
|
import Symbol_observable from 'symbol-observable';
|
|
|
|
someObject[Symbol_observable] = () => {
|
|
return {
|
|
subscribe(observer) {
|
|
const handler = e => observer.next(e);
|
|
someObject.addEventListener('data', handler);
|
|
return {
|
|
unsubscribe() {
|
|
someObject.removeEventListener('data', handler);
|
|
}
|
|
}
|
|
},
|
|
[Symbol_observable]() { return this }
|
|
}
|
|
}
|
|
```
|
|
|
|
Often, it's not very hard, but it can get tricky in some cases.
|
|
|
|
## Related
|
|
|
|
- [is-observable](https://github.com/sindresorhus/is-observable) - Check if a value is an Observable
|
|
- [observable-to-promise](https://github.com/sindresorhus/observable-to-promise) - Convert an Observable to a Promise
|
|
|
|
|
|
## License
|
|
|
|
MIT © [Sindre Sorhus](https://sindresorhus.com) and [Ben Lesh](https://github.com/benlesh)
|