# @types/cmd-shim

> TypeScript definitions for cmd-shim

Latest version **5.0.2** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/cmd-shim
pnpm add @types/cmd-shim
yarn add @types/cmd-shim
bun add @types/cmd-shim
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 5.0.2 |
| Published | 2023-11-07 |
| First published | 2018-01-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51438 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/cmd-shim
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/cmd-shim
- npm.io page: https://npm.io/package/@types/cmd-shim

## Recent versions

- 5.0.2 (latest) — 2023-11-07
- 5.0.0 (ts3.9) — 2022-04-23
- 2.0.1 (ts3.2) — 2020-10-28
- 2.0.0 (ts2.0) — 2018-01-08
- 5.0.1 — 2023-10-17

## README

# 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).

---
_Source: https://npm.io/package/@types/cmd-shim · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._