# vscode-webview-rpc

> ![Version](https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000) ![Prerequisite](https://img.shields.io/badge/node-%3E%3D10-blue.svg) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)

Latest version **0.0.4** (published 2021-03-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install vscode-webview-rpc
pnpm add vscode-webview-rpc
yarn add vscode-webview-rpc
bun add vscode-webview-rpc
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2021-03-21 |
| First published | 2021-03-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 2 |
| Unpacked size | 236.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | aaronphy |
| Maintainers | aaronphy |

## Links

- npm: https://www.npmjs.com/package/vscode-webview-rpc
- npm.io page: https://npm.io/package/vscode-webview-rpc

## Dependencies (2)

- [lodash](https://npm.io/package/lodash.md) ^4.17.21
- [@types/vscode](https://npm.io/package/@types/vscode.md) ^1.54.0

## Recent versions

- 0.0.4 (latest) — 2021-03-21
- 0.0.3 — 2021-03-19
- 0.0.2 — 2021-03-18

## README

# Welcome to vscode-webview-prc 👋
![Version](https://img.shields.io/badge/version-0.0.1-blue.svg?cacheSeconds=2592000)
![Prerequisite](https://img.shields.io/badge/node-%3E%3D10-blue.svg)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](#)

> a rpc lib for vscode webview extension development

## Prerequisites

- node >=10

## Install

```sh
yarn add vscode-webview-rpc
```

## Usage

> extension rpc
```js
import * as vscode from 'vscode';
import { ExtensionRPC } from 'vscode-webview-rpc';


const panel = vscode.window.createWebviewPanel(
			'EditPanel',
			'Blog Editing',
			column || vscode.ViewColumn.One,
			getWebviewOptions(extensionUri),
	);

const RPC = new ExtensionRPC(panel.webview);

RPC.on('log',(e)=>{
  console.log(e);
  return Promise.resolve();
});

```

> webview rpc

```js
import { WebviewRPC } from 'vscode-webview-rpc';

declare var acquireVsCodeApi: any;

let RPC:WebviewRPC;

(()=>{
   RPC = new WebRPC(window, vscode);
   setTimeout(()=>{
     RPC.emit('log',["hello world"]);
   },2000);
})();


```

## Author

👤 **aaronphy**

* Github: [@Aaronphy](https://github.com/Aaronphy)

## Show your support

Give a ⭐️ if this project helped you!


***
_This README was generated with ❤️ by [readme-md-generator](https://github.com/kefranabg/readme-md-generator)_

---
_Source: https://npm.io/package/vscode-webview-rpc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._