diff options
Diffstat (limited to 'frontend-old/node_modules/@firebase/webchannel-wrapper/README.md')
| -rw-r--r-- | frontend-old/node_modules/@firebase/webchannel-wrapper/README.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/frontend-old/node_modules/@firebase/webchannel-wrapper/README.md b/frontend-old/node_modules/@firebase/webchannel-wrapper/README.md new file mode 100644 index 0000000..75ce0a4 --- /dev/null +++ b/frontend-old/node_modules/@firebase/webchannel-wrapper/README.md @@ -0,0 +1,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 +```
\ No newline at end of file |
