# node-clipboardwriter

> > Use electron's clipboard api under the hood to bring cross platform `writeText` and `writeImage` to node.js

Latest version **0.1.0** (published 2018-10-16) · MIT license · 1 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install node-clipboardwriter
pnpm add node-clipboardwriter
yarn add node-clipboardwriter
bun add node-clipboardwriter
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2018-10-16 |
| First published | 2018-10-13 |
| Weekly downloads | 1 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 7 |
| Unpacked size | 269.7 KB |
| Known vulnerabilities | 0 (+60 in 1 direct dependencies) |
| Install scripts | no |
| Maintainers | maple3142 |

## Links

- npm: https://www.npmjs.com/package/node-clipboardwriter
- npm.io page: https://npm.io/package/node-clipboardwriter

## Dependencies (7)

- [express](https://npm.io/package/express.md) ^4.16.4
- [electron](https://npm.io/package/electron.md) ^3.0.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [xfetch-js](https://npm.io/package/xfetch-js.md) ^0.2.1
- [JSONStream](https://npm.io/package/JSONStream.md) ^1.3.4
- [body-parser](https://npm.io/package/body-parser.md) ^1.18.3
- [tmp-promise](https://npm.io/package/tmp-promise.md) ^1.0.5

## Recent versions

- 0.1.0 (latest) — 2018-10-16
- 0.0.1 — 2018-10-13

## README

# node-clipboardwriter

> Use electron's clipboard api under the hood to bring cross platform `writeText` and `writeImage` to node.js

## API

```ts
type imgType = 'PNG' | 'JPEG'
interface ClipboardWriter {
  writeText(text: string): Promise<boolean>
  writeImage(path: string): Promise<boolean>
  writeImage(img: Buffer): Promise<boolean>
  readText(): Promise<string>
  readImage(): Promise<Buffer> // PNG by default
  readImage(type: imgType): Promise<Buffer>
  close(): void
}
type initClipboardWriter = () => Promise<ClipboardWriter>
declare const init: initClipboardWriter
export = init
```

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