| 1 | # @firebase/webchannel-wrapper
|
| 2 |
|
| 3 | _NOTE: This is specifically tailored for Firebase JS SDK usage, if you are not a member of the Firebase team, please avoid using this package_
|
| 4 |
|
| 5 | This is a wrapper of some Webchannel Features for the Firebase JS SDK.
|
| 6 |
|
| 7 | ## Usage
|
| 8 |
|
| 9 | The following 5 modules are exposed for use:
|
| 10 |
|
| 11 | - `createWebChannelTransport`
|
| 12 | - `ErrorCode`
|
| 13 | - `EventType`
|
| 14 | - `WebChannel`
|
| 15 | - `XhrIoPool`
|
| 16 |
|
| 17 | You can include these by doing the following:
|
| 18 |
|
| 19 | **ES Modules**
|
| 20 |
|
| 21 | ```javascript
|
| 22 | import { WebChannel } from '@firebase/webchannel-wrapper'
|
| 23 |
|
| 24 | // Do stuff with WebChannel
|
| 25 | ```
|
| 26 |
|
| 27 | **CommonJS Modules**
|
| 28 |
|
| 29 | ```javascript
|
| 30 | const webchannelWrapper = require('@firebase/webchannel-wrapper');
|
| 31 |
|
| 32 | // Do stuff with webchannelWrapper.ErrorCode, webchannelWrapper.EventType, etc
|
| 33 | ``` |
| \ | No newline at end of file |