@tomjs/vscode-webview

![npm](https://www.npmjs.com/package/@tomjs/vscode-webview) !node-current (scoped) !NPM ![jsDocs.io](https://www.jsdocs.io/package/@tomjs/vscode-webview)

English | 中文

> 优化 webview 页面与 vscode 扩展的 postMessage 问题

对官方的 @types/vscode-webview 进行了封装并增加了一些方法。

安装

``bash

`pnpm`


pnpm add @tomjs/vscode-webview
yarn

yarn add @tomjs/vscode-webview
npm

npm add @tomjs/vscode-webview


文档
- jsdocs.io 提供的 API Document.
- unpkg.com 提供的 index.d.ts.
使用
$3
#### getState(): any
获取此 webview 存储的持久状态。
#### setState(state: any): any
设置此 webview 存储的持久状态。
#### postMessage(message:any)
向 WebView 的所有者发布消息
#### post(type, message, options)
发送消息
- type: 消息类型
- message: 消息内容
- options: 配置项
#### postAndReceive(type, message, options): Promise
发送并接收消息
- type: 消息类型
- message: 消息内容
- options: 配置项
#### on(type, success[, fail])
监听消息
- type: 消息类型
- success: 监听成功回调函数
- fail: 监听失败回调函数
#### off(type)
取消监听消息
- type: 消息类型
重要说明
$3
破坏性更新：

- 导出由官方 @types/vscode-webview 的WebviewApi 来封装的 WebviewApi类 -postMessage 方法修改为与官方的 WebviewApi实例的方法一致 - 原postMessage 和 postAndReceiveMessage 方法名改为 post 和 postAndReceive- 删除WebviewApi 的实例：vscodeWebview 和 webviewApi`，需要手动引入并实例化