scaleway/DefinitelyTyped

scaleway/DefinitelyTyped

Description: The repository for high quality TypeScript type definitions.

License: NOASSERTION

Stars: 0

Forks: 0

Open issues: 0

Created: 2021-08-04T17:17:35Z

Pushed: 2021-08-04T17:12:13Z

Default branch: master

Fork: yes

Parent repository: DefinitelyTyped/DefinitelyTyped

Archived: no

README:

Definitely Typed

> The repository for *high quality* TypeScript type definitions.

*You can also read this README in Spanish, Korean, Russian, Chinese, Portuguese, Italian and Japanese!*

*Link to [Admin manual](./docs/admin.md)*

Contents

• [Current status](#current-status)
• [What are declaration files and how do I get them?](#what-are-declaration-files-and-how-do-i-get-them)
• [How can I contribute?](#how-can-i-contribute)
• [Testing](#testing)
• [Make a pull request](#make-a-pull-request)
• [Partial clone](#partial-clone)
• [Edit an existing package](#edit-an-existing-package)
• [Create a new package](#create-a-new-package)
• [Removing a package](#removing-a-package)
• [Running tests](#running-tests)
• [Naming](#naming)
• [-tests.ts](#my-package-teststs)
• [Linter: tslint.json](#linter-tslintjson)
• [tsconfig.json](#tsconfigjson)
• [package.json](#packagejson)
• [OTHER_FILES.txt](#other_filestxt)
• [Common mistakes](#common-mistakes)

• [Definition owners](#definition-owners)
• [FAQ](#faq)
• [License](#license)

Current status

This section tracks the health of the repository and publishing process. It may be helpful for contributors experiencing any issues with their PRs and packages.

• Most recent build type-checked/linted cleanly: 
• All packages are type-checking/linting cleanly on typescript@next: 
• All packages are being published to npm in under an hour and a half: 
• typescript-bot has been active on Definitely Typed 
• Current infrastructure status updates

If anything here seems wrong, or any of the above are failing, please let us know in the Definitely Typed channel on the TypeScript Community Discord server.

What are declaration files and how do I get them?

See the TypeScript handbook.

npm

This is the preferred method. For example:

npm install --save-dev @types/node

The types should then be automatically included by the compiler. You may need to add a types reference if you're not using modules:

///

See more in the handbook.

For an npm package "foo", typings for it will be at "@types/foo". If you can't find your package, look for it on TypeSearch.

If you still can't find it, check if it bundles its own typings. This is usually provided in a "types" or "typings" field in the package.json, or just look for any ".d.ts" files in the package and manually include them with a /// .

Support Window

Definitely Typed only tests packages on versions of TypeScript that are less than 2 years old.

Currently versions 3.6 and above are tested...

If you're using TypeScript 2.0 to 3.5, you can still try installing @types packages — the majority of packages don't use fancy new TypeScript features. But there's no guarantee that they'll work. Here is the support window:

| Version | Released | End of Support | | ------- | -------------- | -------------- | | 2.8 | March 2018 | March 2020 | | 2.9 | May 2018 | May 2020 | | 3.0 | July 2018 | August 2020 | | 3.1 | September 2018 | September 2020 | | 3.2 | November 2018 | November 2020 | | 3.3 | January 2019 | January 2021 | | 3.4 | March 2019 | March 2021 | | 3.5 | May 2019 | May 2021 | | 3.6 | August 2019 | August 2021 | | 3.7 | November 2019 | November 2021 | | 3.8 | February 2020 | February 2022 | | 3.9 | May 2020 | May 2022 | | 4.0 | August 2020 | August 2022 | | 4.1 | November 2020 | November 2022 | | 4.2 | February 2021 | February 2023 | | 4.3 | May 2021 | May 2023 |

@types packages have tags for versions of TypeScript that they explicitly support, so you can usually get older versions of packages that predate the 2-year window. For example, if you run npm dist-tags @types/react, you'll see that TypeScript 2.5 can use types for react@16.0, whereas TypeScript 2.6 and 2.7 can use types for react@16.4:

| Tag | Version | | ------ | ------- | | latest | 16.9.23 | | ts2.0 | 15.0.1 | | ... | ... | | ts2.5 | 16.0.36 | | ts2.6 | 16.4.7 | | ts2.7 | 16.4.7 | | ... | ... |

TypeScript 1.*

• Manually download from the master branch of this repository and place them in your project

*…