Azure
/
azure-sdk-for-js
зеркало из
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность
azure-sdk-for-js/sdk/web-pubsub/web-pubsub-client-protobuf
История
Jeremy Meng ae84780ce1
[dev-tool] stop rolling up types for ESM (#31720) 
For packages that have been migrated to ESM, Rolled up dts files are no
longer used but they are still packaged because our `files` field
include an entry of `dist/`. Since they are not used anymore, this PR
stops generating them, instead of more complicated approach of excluding
them from `npm pack`.
 		2024-11-13 10:01:13 -08:00
..
.vscode
…
review [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
samples/v1-beta [EngSys] move to vendored version of cross-env via dev-tool 2024-11-02 00:48:06 +00:00
samples-dev [web pub sub] update protobuf to ESM (#31044) 2024-09-11 12:50:57 -04:00
src [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
test [eslint-plugin] add rule "@typescript-eslint/consistent-type-imports": "warn" 2024-10-30 15:48:52 +00:00
CHANGELOG.md Post release automated changes for web-pubsub releases (#27616) 2023-11-09 13:17:30 -08:00
README.md [eslint] move web-pubsub-client to flat config (#30825) 2024-08-21 16:04:06 +08:00
api-extractor.json [web pub sub] update protobuf to ESM (#31044) 2024-09-11 12:50:57 -04:00
eslint.config.mjs Apply automated migration to eslint flat config 2024-08-22 11:43:19 -07:00
package.json [dev-tool] stop rolling up types for ESM (#31720) 2024-11-13 10:01:13 -08:00
sample.env
…
tsconfig.json [web pub sub] update protobuf to ESM (#31044) 2024-09-11 12:50:57 -04:00
vitest.config.ts [web pub sub] update protobuf to ESM (#31044) 2024-09-11 12:50:57 -04:00

README.md

Web PubSub client protobuf protocol library for JavaScript

Azure Web PubSub is a cloud service that helps developers easily build real-time features in web applications with publish-subscribe patterns at scale.

You can use this library to add protobuf subprotocols including protobuf.reliable.webpubsub.azure.v1 and protobuf.webpubsub.azure.v1 support to @azure/web-pubsub-client library.

Getting started

Currently supported environments

Prerequisites

1. Install the @azure/web-pubsub-client-protobuf package

npm install @azure/web-pubsub-client-protobuf

2. Use Protobuf protocols

const client = new WebPubSubClient("client-access-url", { protocol: WebPubSubProtobufReliableProtocol() });

Troubleshooting

  • Enable logs

    You can set the following environment variable to get the debug logs when using this library.

export AZURE_LOG_LEVEL=verbose

For more detailed instructions on how to enable logs, you can look at the @azure/logger package docs.

  • Live Trace

    Use Live Trace tool from Web PubSub portal to view the live traffic.

Additional resources

Contributing

If you'd like to contribute to this library, please read the contributing guide to learn more about how to build and test the code.