JSPM

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

TypeScript definitions for clone

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/clone) 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/clone

    Summary

    This package contains type definitions for clone (https://github.com/pvorb/node-clone).

    Details

    Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/clone.

    index.d.ts

    /**
     * See clone JS source for API docs
     */
    
    /**
     * @param val the value that you want to clone, any type allowed
     * @param circular Call clone with circular set to false if you are certain that obj contains no circular references. This will give better performance if needed. There is no error if undefined or null is passed as obj.
     * @param depth to which the object is to be cloned (optional, defaults to infinity)
     * @param prototype Sets the prototype to be used when cloning an Object (optional, defaults to __proto__)
     * @param includeNonEnumerable Set to true if the non-enumerable properties should be cloned as well (optional, defaults to false)
     */
    declare function clone<T>(
        val: T,
        circular?: boolean,
        depth?: number,
        prototype?: any,
        includeNonEnumerable?: boolean,
    ): T;
    
    /**
     * @param val the value that you want to clone, any type allowed
     * @param opts a single object that specifies circular, depth, prototype and includeNonEnumerable.
     * @param opts.circular Call clone with circular set to false if you are certain that obj contains no circular references. This will give better performance if needed. There is no error if undefined or null is passed as obj.
     * @param opts.depth Sets depth to which the object is to be cloned (optional, defaults to infinity)
     * @param opts.prototype Sets the prototype to be used when cloning an Object (optional, defaults to __proto__)
     * @param opts.includeNonEnumerable Set to true if the non-enumerable properties should be cloned as well (optional, defaults to false)
     */
    declare function clone<T>(val: T, opts: CloneOpts): T;
    
    interface CloneOpts {
        circular?: boolean | undefined;
        depth?: number | undefined;
        prototype?: any;
        includeNonEnumerable?: boolean | undefined;
    }
    
    declare namespace clone {
        /**
         * @param obj the object that you want to clone
         */
        function clonePrototype<T>(obj: T): T;
    }
    
    export = clone;
    

    Additional Details

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

    Credits

    These definitions were written by Kieran Simpson, and DG-za.