36 lines
623 B
Markdown
36 lines
623 B
Markdown
# tinyclip 📋
|
|
|
|
A tiny cross-platform clipboard library. Uses native OS clipboard functionality on Node.js.
|
|
|
|
> [!NOTE]
|
|
> In the browser, you can use the native [Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/Clipboard_API) instead of a dependency.
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install tinyclip
|
|
```
|
|
|
|
## Usage
|
|
|
|
```js
|
|
import {readText, writeText} from 'tinyclip';
|
|
|
|
await writeText('hello world');
|
|
const text = await readText();
|
|
```
|
|
|
|
## API
|
|
|
|
### `readText(): Promise<string>`
|
|
|
|
Reads text from the clipboard.
|
|
|
|
### `writeText(text: string): Promise<void>`
|
|
|
|
Writes text to the clipboard.
|
|
|
|
## License
|
|
|
|
[MIT](./LICENSE)
|