summaryrefslogtreecommitdiff
path: root/frontend-old/node_modules/@firebase/webchannel-wrapper/README.md
blob: 75ce0a4ce7a888d9665867164261cdd9695d7dd9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
# @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.

## 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 
```