createDevToolsV2Message()
function createDevToolsV2Message<TType>(
type,
payload,
options
): DevToolsV2Envelope<TType>;
Defined in: v2/wire.ts:431
构造一条 v2 消息。
Type Parameters
| Type Parameter | Description |
|---|---|
TType extends | "HANDSHAKE" | "HANDSHAKE_ACK" | "EVENT" | "DISCONNECT" | "PING" | "PROTOCOL_HELLO" | "PONG" | "CLEAR_EVENT_BUFFER" | "REQUEST" | "RESPONSE" | "ERROR" | "TRANSFER_START" | "TRANSFER_CHUNK" | "TRANSFER_COMPLETE" | "TRANSFER_CANCEL" | 消息类型。 |
Parameters
| Parameter | Type | Description |
|---|---|---|
type | TType | 消息类型。 |
payload | DevToolsV2PayloadMap[TType] | 与类型匹配的载荷。 |
options | DevToolsV2MessageOptions | session、序号、时间戳与(双向消息的)方向。 |
Returns
DevToolsV2Envelope<TType>
自洽的 v2 消息,必然通过 isDevToolsV2Message。
Remarks
方向由类型推导而不是由调用方自由填写,是为了让「ACK 只能由 panel 产出」这类所有权约束 在发送侧就成立,而不是等到接收侧才发现方向不对。
Throws
TypeError 当双向消息缺少方向、或单向消息给出冲突方向时。