Class ArticleChannel

文章实时频道

Hierarchy

WsEventBase<IArticleEvents>
- ArticleChannel

Index

Constructors

Properties

emitter rwsOptions ws

Methods

addListener clearListener connect off on once reconnect removeListener

Constructors

constructor

new ArticleChannel(token: string, id: string, type: ArticleType): ArticleChannel
实例化文章频道
Parameters
- token: string
  认证 Token
- id: string
  文章 Id
- type: ArticleType
  文章类型
Returns ArticleChannel
Overrides WsEventBase<IArticleEvents>.constructor
- Defined in article.ts:438

Properties

emitter

emitter: BrowserEventEmitter = ...

事件触发器

rwsOptions

rwsOptions: Options = ...

WebSocket 配置

ws

ws: ReconnectingWebSocket | null = null

WebSocket 连接对象

Methods

addListener

addListener<K extends keyof IArticleEvents>(
event: K,
listener: IArticleEvents[K],
): BrowserEventEmitter
添加 WebSocket 消息监听函数
Type Parameters
- K extends keyof IArticleEvents
Parameters
- event: K
  WebSocket 事件
- listener: IArticleEvents[K]
  监听器
Returns BrowserEventEmitter
Inherited from WsEventBase.addListener
- Defined in ws.ts:131

clearListener

clearListener(event?: keyof IArticleEvents): void
清除 WebSocket 监听
Parameters
- Optionalevent: keyof IArticleEvents
Returns void
Inherited from WsEventBase.clearListener
- Defined in ws.ts:113

connect

connect(reload?: boolean): Promise<ReconnectingWebSocket>
连接实时频道
Parameters
- Optionalreload: boolean
  是否强制重连
Returns Promise<ReconnectingWebSocket>
WebSocket 实例
Overrides WsEventBase.connect
- Defined in article.ts:450

off

off<K extends keyof IArticleEvents>(
event?: K,
listener?: IArticleEvents[K],
): BrowserEventEmitter
移除 WebSocket 监听
Type Parameters
- K extends keyof IArticleEvents
Parameters
- Optionalevent: K
  WebSocket 事件
- Optionallistener: IArticleEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.off
- Defined in ws.ts:94

on

on<K extends keyof IArticleEvents>(
event: K,
listener: IArticleEvents[K],
): BrowserEventEmitter
WebSocket 监听
Type Parameters
- K extends keyof IArticleEvents
Parameters
- event: K
  WebSocket 事件
- listener: IArticleEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.on
- Defined in ws.ts:81

once

once<K extends keyof IArticleEvents>(
event: K,
listener: IArticleEvents[K],
): BrowserEventEmitter
WebSocket 单次监听
Type Parameters
- K extends keyof IArticleEvents
Parameters
- event: K
  WebSocket 事件
- listener: IArticleEvents[K]
  监听器
Returns BrowserEventEmitter
EventEmitter
Inherited from WsEventBase.once
- Defined in ws.ts:106

reconnect

reconnect(): Promise<unknown>
重连通知频道

Returns Promise<unknown>
Websocket 连接对象
Inherited from WsEventBase.reconnect
- Defined in ws.ts:52

removeListener

removeListener<K extends keyof IArticleEvents>(
event: K,
listener: IArticleEvents[K],
): BrowserEventEmitter
移除 WebSocket 消息监听函数
Type Parameters
- K extends keyof IArticleEvents
Parameters
- event: K
  WebSocket 事件
- listener: IArticleEvents[K]
  监听器
Returns BrowserEventEmitter
Inherited from WsEventBase.removeListener
- Defined in ws.ts:122