universal-clipboard-js

Ready to be a universal clipboard library for all platforms.

中文｜English

How to use

very simple

1const { readText, writeText, FORMAT_FILE_URL } = require('../index.js')
2console.log(readText(), 'result')
3console.log(readText(FORMAT_FILE_URL), 'file path result')
4
5console.log(
6  writeText(
7    'file:///Users/ZhangXiaohua/Documents/LearningMaterials/C++FromEntryToGrave.pdf',
8    FORMAT_FILE_URL
9  ),
10  'writeText result'
11)

API

1// clear your clipboard
2export function clear(): void
3
4// read or write buffer to clipboard
5// The default value of format is FORMAT_PLAIN_TEXT
6export function readBuffer(format?: string): Buffer
7export function writeBuffer(data: Buffer, format?: string): boolean
8
9// read or write text to clipboard
10// The default value of format is FORMAT_PLAIN_TEXT
11export function readText(format?: string): string
12export function writeText(text: string, format?: string): boolean
13
14// clipboard content fromat, text or file path
15export const FORMAT_PLAIN_TEXT: string
16export const FORMAT_FILE_URL: string

TODO

• Window
• Linux
• ......

Support

• MacOS