Newlywed Party Monsters

    clipboardy
    TypeScript icon, indicating that this package has built-in type declarations

    3.0.0 • Public • Published

    clipboardy

    Access the system clipboard (copy/paste)

    Cross-platform. Supports: macOS, Windows, Linux, OpenBSD, FreeBSD, Android with Termux, and modern browsers.

    Install

    npm install clipboardy

    Usage

    import clipboard from 'clipboardy';
    
    clipboard.writeSync('🦄');
    
    clipboard.readSync();
    //=> '🦄'

    API

    clipboard

    .write(text)

    Write (copy) to the clipboard asynchronously.

    Returns a Promise.

    text

    Type: string

    The text to write to the clipboard.

    .read()

    Read (paste) from the clipboard asynchronously.

    Returns a Promise.

    .writeSync(text)

    Write (copy) to the clipboard synchronously.

    Doesn't work in browsers.

    text

    Type: string

    The text to write to the clipboard.

    .readSync()

    Read (paste) from the clipboard synchronously.

    Doesn't work in browsers.

    FAQ

    Where can I find the source of the bundled binaries?

    The Linux binary is just a bundled version of xsel. The source for the Windows binary can be found here.

    Related

    Install

    npm i clipboardy

    DownloadsWeekly Downloads

    4,242,243

    Version

    3.0.0

    License

    MIT

    Unpacked Size

    915 kB

    Total Files

    13

    Last publish

    Collaborators

    • floatdrop
    • sindresorhus