# indefinitely-typed

> 🐣 Incubate your TypeScript declarations

Latest version **1.1.0** (published 2020-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install indefinitely-typed
pnpm add indefinitely-typed
yarn add indefinitely-typed
bun add indefinitely-typed
```

Provides the command `indefinitely-typed`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.0 |
| Published | 2020-04-15 |
| First published | 2018-10-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 6.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Dan Marshall |
| Maintainers | danmarshall |
| Keywords | TypeScript, DefinitelyTyped |

## Links

- npm: https://www.npmjs.com/package/indefinitely-typed
- Repository: https://github.com/danmarshall/indefinitely-typed
- Homepage: https://github.com/danmarshall/indefinitely-typed#readme
- Issues: https://github.com/danmarshall/indefinitely-typed/issues
- npm.io page: https://npm.io/package/indefinitely-typed

## Dependencies (2)

- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [minimist](https://npm.io/package/minimist.md) ^1.2.5

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2020-04-15
- 1.0.4 — 2020-04-13
- 1.0.3 — 2020-04-03
- 1.0.2 — 2018-10-15
- 1.0.1 — 2018-10-15
- 1.0.0 — 2018-10-15

## README

# 🐣 indefinitely-typed

For TypeScript declarations that are still ...hatching.

## What this does

Copies your folders into the dependee's `node_modules/@types/` folder. Because that's where the TypeScript compiler might look for it - see [TypeScript Module Resolution](https://www.typescriptlang.org/docs/handbook/module-resolution.html).

## Why you may need it

[DefinitelyTyped](http://definitelytyped.org/) is the repository for __high quality__ TypeScript type definitions. Use this tool if:
* your definitions are "pre-release", lacking tests or incomplete, but you still need to use them in a project.
* you need to maintain versioning not possible with the [@types publisher](https://github.com/Microsoft/types-publisher).
* you need to publish on demand, and not wait for the [@types publisher](https://github.com/Microsoft/types-publisher).

## Usage

Let's say that you want to create TypeScript declarations for `cool-package`.

1. Create an NPM package for your typings, perhaps name it `cool-package-typings`.
1. `npm install indefinitely-typed`.
1. Create a folder named `cool-package`.
1. Add declaration files in this folder, like `index.d.ts`.
1. In the `package.json`'s `scripts`, add a `postinstall` script like this:
```
"postinstall": "indefinitely-typed --folder cool-package"
```

Now, when somebody installs `cool-package-typings`, they will have a `node_modules/@types/cool-package` folder, readily usable by their TypeScript project.


### Multiple packages
If you have multiple packages, add more folder parameters like this:
```
indefinitely-typed --folder folder1 --folder folder2 --folder folder3
```

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