@azure/web-pubsub package

Classes

AzureKeyCredential	A static-key-based credential that supports updating the underlying key value.
WebPubSubServiceClient	Client for connecting to a Web PubSub hub

Interfaces

ClientTokenResponse	A response containing the client token.
GenerateClientTokenOptions	Options for generating a token to connect a client to the Azure Web Pubsub service.
GroupAddConnectionOptions	Options for adding a connection to a group.
GroupAddUserOptions	Options for adding a user to a group.
GroupAdminClientOptions	Options for constructing a GroupAdmin client.
GroupCloseAllConnectionsOptions	Options for closing all connections to a group.
GroupHasUserOptions	Options for checking if a user is in a group
GroupListConnectionsOptions	Options for listing connections in a group.
GroupRemoveConnectionOptions	Options for removing a connection from a group
GroupRemoveUserOptions	Options for removing a user from a group
GroupSendTextToAllOptions	Options for sending text messages to a group..
GroupSendToAllOptions	Options for sending messages to a group.
HasConnectionOptions	Options for checking if a connection exists.
HubCloseAllConnectionsOptions	Options for closing all connections to a hub.
HubCloseConnectionOptions	Options for closing a connection to a hub.
HubCloseUserConnectionsOptions	Options for closing all of a user's connections to a hub.
HubGrantPermissionOptions	Options for grant permissions to a connection
HubHasGroupOptions	Options for checking if a group exists.
HubHasPermissionOptions	Options for checking if a connection has the specified permission
HubHasUserOptions	Options for checking if a user exists.
HubRemoveUserFromAllGroupsOptions	Options for removing a user from all groups.
HubRevokePermissionOptions	Options for revoke permissions from a connection
HubSendTextToAllOptions	Options for sending text messages to hubs.
HubSendTextToConnectionOptions	Options for sending a text message to a connection.
HubSendTextToUserOptions	Options for sending a text message to a user.
HubSendToAllOptions	Options for sending messages to hubs.
HubSendToConnectionOptions	Options for sending a message to a specific connection.
HubSendToUserOptions	Options for sending a message to a user.
WebPubSubGroup
WebPubSubGroupMember	A connection in a group in the Web PubSub service.
WebPubSubServiceClientLogOptions	Options to configure the logging options.
WebPubSubServiceClientOptions	Options for constructing a HubAdmin client.

Type Aliases

JSONTypes	Types which can be serialized and sent as JSON.
Permission
WebPubSubClientProtocol	The type of client endpoint that is being requested.

Functions

odata(TemplateStringsArray, unknown[])

Escapes an odata filter expression to avoid errors with quoting string literals. Example usage: import { odata } from "@azure/web-pubsub"; const userId = "vic's"; const anonymous = null; const length = 3; const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

Function Details

odata(TemplateStringsArray, unknown[])

Escapes an odata filter expression to avoid errors with quoting string literals. Example usage:

import { odata } from "@azure/web-pubsub";

const userId = "vic's";
const anonymous = null;
const length = 3;
const filter = odata`userId eq ${anonymous} or userId eq ${userId} or length(userId) > ${length}`;

function odata(strings: TemplateStringsArray, values: unknown[]): string

Parameters

strings

TemplateStringsArray

Array of strings for the expression

values

unknown[]

Array of values for the expression

Returns

string