mirror of
https://github.com/musix-org/musix-oss
synced 2024-11-14 03:30:18 +00:00
41 lines
893 B
Markdown
41 lines
893 B
Markdown
|
# @firebase/webchannel-wrapper
|
||
|
|
|
||
|
|
_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_
|
||
|
|
|
||
|
|
This is a wrapper of some Webchannel Features for the Firebase JS SDK.
|
||
|
|
|
||
|
|
## Installation
|
||
|
|
|
||
|
|
You can install this wrapper by running the following in your project:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ npm install @firebase/webchannel-wrapper
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
The following 5 modules are exposed for use:
|
||
|
|
|
||
|
|
- `createWebChannelTransport`
|
||
|
|
- `ErrorCode`
|
||
|
|
- `EventType`
|
||
|
|
- `WebChannel`
|
||
|
|
- `XhrIoPool`
|
||
|
|
|
||
|
|
You can include these by doing the following:
|
||
|
|
|
||
|
|
**ES Modules**
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
import { WebChannel } from '@firebase/webchannel-wrapper'
|
||
|
|
|
||
|
|
// Do stuff with WebChannel
|
||
|
|
```
|
||
|
|
|
||
|
|
**CommonJS Modules**
|
||
|
|
|
||
|
|
```javascript
|
||
|
|
const webchannelWrapper = require('@firebase/webchannel-wrapper');
|
||
|
|
|
||
|
|
// Do stuff with webchannelWrapper.ErrorCode, webchannelWrapper.EventType, etc
|
||
|
|
```
|