@types/cmd-shim/README.md

TypeScript definitions for cmd-shim

# Installation
> `npm install --save @types/cmd-shim`

# Summary
This package contains type definitions for cmd-shim (https://github.com/npm/cmd-shim).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cmd-shim.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cmd-shim/index.d.ts)
````ts
/**
 * Create a cmd shim at `to` for the command line program at `from`. e.g.
 *
 * cmdShim(__dirname + '/cli.js', '/usr/bin/command-name');
 */
declare function cmdShim(from: string, to: string): Promise<void>;

declare namespace cmdShim {
    /**
     * Create a cmd shim at `to` for the command line program at `from`, but will just
     * continue if the file does not exist.
     *
     * cmdShim.ifExists(__dirname + '/cli.js', '/usr/bin/command-name');
     */
    function ifExists(from: string, to: string): Promise<void>;
}

export = cmdShim;

````

### Additional Details
 * Last updated: Mon, 06 Nov 2023 22:41:05 GMT
 * Dependencies: none

# Credits
These definitions were written by [Andrew Bradley](https://github.com/cspotcode), and [Hiroki Osame](https://github.com/privatenumber).