https://github.com/danmarshall/indefinitely-typed

🐣 Incubate your TypeScript declarations
https://github.com/danmarshall/indefinitely-typed

declarations definitelytyped typescript

Last synced: about 5 hours ago
JSON representation

🐣 Incubate your TypeScript declarations

• Host: GitHub
• URL: https://github.com/danmarshall/indefinitely-typed
• Owner: danmarshall
• License: mit
• Created: 2018-10-15T05:39:33.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2022-05-27T19:43:43.000Z (over 2 years ago)
• Last Synced: 2024-04-28T01:50:32.459Z (6 months ago)
• Topics: declarations, definitelytyped, typescript
• Language: TypeScript
• Homepage:
• Size: 31.3 KB
• Stars: 13
• Watchers: 3
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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/DefinitelyTyped-tools).

* you need to publish on demand, and not wait for the [@types publisher](https://github.com/microsoft/DefinitelyTyped-tools).

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

```