JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 8613
  • Score
    100M100P100Q127104F
  • License MIT

TypeScript definitions for copy-paste

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@types/copy-paste) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    Installation

    npm install --save @types/copy-paste

    Summary

    This package contains type definitions for copy-paste (https://github.com/xavi-/node-copy-paste).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/copy-paste.

    index.d.ts

    export type CopyCallback = (err: Error) => void;
    export type PasteCallback = (err: Error, content: string) => void;
    
    /**
     * Asynchronously replaces the current contents of the clip board with text.
     *
     * @param {T} content Takes either a string, array, object, or readable stream.
     * @return {T} Returns the same value passed in.
     */
    export declare function copy<T>(content: T): T;
    
    /**
     * Asynchronously replaces the current contents of the clip board with text.
     *
     * @param {T} content Takes either a string, array, object, or readable stream.
     * @param {CopyCallback} callback will fire when the copy operation is complete.
     * @return {T} Returns the same value passed in.
     */
    export declare function copy<T>(content: T, callback: CopyCallback): T;
    
    /**
     * Synchronously returns the current contents of the system clip board.
     *
     * Note: The synchronous version of paste is not always availabled.
     * An error message is shown if the synchronous version of paste is used on an unsupported platform.
     * The asynchronous version of paste is always available.
     *
     * @return {string} Returns the current contents of the system clip board.
     */
    export declare function paste(): string;
    
    /**
     * Asynchronously returns the current contents of the system clip board.
     *
     * @param {PasteCallback} callback The contents of the system clip board are passed to the callback as the second parameter.
     */
    export declare function paste(callback: PasteCallback): void;
    

    Additional Details

    • Last updated: Mon, 06 Nov 2023 22:41:05 GMT
    • Dependencies: none

    Credits

    These definitions were written by Tobias Kahlert.