跳到主要内容

DevToolsPanelEndpoint

Defined in: v2/panel-endpoint.ts:146

panel 数据面客户端。

Properties​

capability​

readonly capability: DevToolsCapability | null;

Defined in: v2/panel-endpoint.ts:156

connector 声明的档位;未协商成功时为 null。


descriptors​

readonly descriptors: readonly DevToolsProviderDescriptor[];

Defined in: v2/panel-endpoint.ts:158

connector 声明的 provider descriptor;未协商成功时为空。


downgraded​

readonly downgraded: boolean;

Defined in: v2/panel-endpoint.ts:154

已进入 v1 facade 却发现对端会说 v2——提示用户重连以升级。


inflightRequests​

readonly inflightRequests: number;

Defined in: v2/panel-endpoint.ts:160

在途请求数。


inflightTransfers​

readonly inflightTransfers: number;

Defined in: v2/panel-endpoint.ts:162

在途上传数。


rejectedFrames​

readonly rejectedFrames: number;

Defined in: v2/panel-endpoint.ts:166

被拒帧数(含协商机拒掉的);「拒绝」是可数的,「沉默」不是。


rejection​

readonly rejection: DevToolsErrorPayload | null;

Defined in: v2/panel-endpoint.ts:164

对端在协商期回报的错误。


sessionId​

readonly sessionId: string | null;

Defined in: v2/panel-endpoint.ts:150

当前 session;未协商或已断开时为 null。


sessionOpen​

readonly sessionOpen: boolean;

Defined in: v2/panel-endpoint.ts:152

session 是否仍然开着。


state​

readonly state: DevToolsPanelNegotiationState;

Defined in: v2/panel-endpoint.ts:148

协商状态。

Methods​

clearEventBuffer()​

clearEventBuffer(): void;

Defined in: v2/panel-endpoint.ts:202

请求 connector 清空本 session 的事件缓冲。

Returns​

void


disconnect()​

disconnect(): void;

Defined in: v2/panel-endpoint.ts:206

主动断开:发 DISCONNECT 并就地结算所有在途工作。

Returns​

void


dispose()​

dispose(): void;

Defined in: v2/panel-endpoint.ts:208

停止收发并结算所有在途工作。

Returns​

void


download()​

download(request): Promise<DevToolsPanelDownloadResult>;

Defined in: v2/panel-endpoint.ts:193

驱动一次 files.download。

Parameters​

ParameterTypeDescription
requestDevToolsPanelDownloadRequestparams 构造器与字节下沉口。

Returns​

Promise<DevToolsPanelDownloadResult>

永不 reject 的结果;三个分支的语义见 DevToolsPanelDownloadResult。


onEvent()​

onEvent(listener): () => void;

Defined in: v2/panel-endpoint.ts:200

订阅 connector 推来的事件。

Parameters​

ParameterTypeDescription
listener(event) => void事件回调。

Returns​

退订函数;幂等。

() => void


ping()​

ping(): void;

Defined in: v2/panel-endpoint.ts:204

发送 PING。

Returns​

void


receive()​

receive(frame): void;

Defined in: v2/panel-endpoint.ts:170

处理一帧入站消息。

Parameters​

ParameterType
frameunknown

Returns​

void


request()​

request(
domain,
operation,
params
): Promise<DevToolsPanelRequestResult>;

Defined in: v2/panel-endpoint.ts:179

发起一次 provider 调用。

Parameters​

ParameterTypeDescription
domain"database" | "files" | "settings"provider 领域。
operationstring领域内的操作名。
paramsunknown操作参数,按 provider 契约构造。

Returns​

Promise<DevToolsPanelRequestResult>

永不 reject 的结果。


start()​

start(): void;

Defined in: v2/panel-endpoint.ts:168

发出首个 PROTOCOL_HELLO。

Returns​

void


upload()​

upload(request): Promise<DevToolsPanelUploadResult>;

Defined in: v2/panel-endpoint.ts:186

驱动一次 files.upload。

Parameters​

ParameterTypeDescription
requestDevToolsPanelUploadRequestparams 构造器与字节来源。

Returns​

Promise<DevToolsPanelUploadResult>

永不 reject 的结果;成功语义见 DevToolsPanelUploadResult。