Beignet API reference
Preparing search index...
@beignet/provider-broadcast-redis
RedisBroadcast
Interface RedisBroadcast
interface
RedisBroadcast
{
close
()
:
Promise
<
void
>
;
publish
<
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
,
>
(
channel
:
C
,
publication
:
BroadcastPublication
<
C
>
,
)
:
Promise
<
void
>
;
start
()
:
Promise
<
void
>
;
subscribe
<
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
,
>
(
channel
:
C
,
options
:
{
onDisconnect
:
()
=>
void
;
onEvent
:
(
event
:
InferChannelEvent
<
C
>
,
metadata
:
{
excludeOrigin
?:
BroadcastOrigin
}
,
)
=>
void
;
params
:
InferChannelParams
<
C
>
;
}
,
)
:
BroadcastSubscription
;
}
Hierarchy (
View Summary
)
BroadcastPort
RedisBroadcast
Index
Methods
close
publish
start
subscribe
Methods
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
publish
publish
<
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
,
>
(
channel
:
C
,
publication
:
BroadcastPublication
<
C
>
,
)
:
Promise
<
void
>
Resolves when accepted by the provider, including when nobody is subscribed.
Type Parameters
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
Parameters
channel
:
C
publication
:
BroadcastPublication
<
C
>
Returns
Promise
<
void
>
start
start
()
:
Promise
<
void
>
Returns
Promise
<
void
>
subscribe
subscribe
<
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
,
>
(
channel
:
C
,
options
:
{
onDisconnect
:
()
=>
void
;
onEvent
:
(
event
:
InferChannelEvent
<
C
>
,
metadata
:
{
excludeOrigin
?:
BroadcastOrigin
}
,
)
=>
void
;
params
:
InferChannelParams
<
C
>
;
}
,
)
:
BroadcastSubscription
Type Parameters
C
extends
ChannelDefinition
<
string
,
StandardSchemaV1
<
unknown
,
Record
<
string
,
string
>
>
,
Record
<
string
,
StandardSchemaV1
<
unknown
,
unknown
>
>
,
>
Parameters
channel
:
C
options
:
{
onDisconnect
:
()
=>
void
;
onEvent
:
(
event
:
InferChannelEvent
<
C
>
,
metadata
:
{
excludeOrigin
?:
BroadcastOrigin
}
,
)
=>
void
;
params
:
InferChannelParams
<
C
>
;
}
Returns
BroadcastSubscription
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
close
publish
start
subscribe
Beignet API reference
Loading...
Resolves when accepted by the provider, including when nobody is subscribed.