Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/un-ts/types

TypeScript Type Definitions same as DefinitelyTyped.
https://github.com/un-ts/types

types typescript typescript-definitions typings

Last synced: about 1 month ago
JSON representation

TypeScript Type Definitions same as DefinitelyTyped.

Awesome Lists containing this project

README

        

# @rxts/types

[![GitHub Actions](https://github.com/rx-ts/types/workflows/CI/badge.svg)](https://github.com/rx-ts/types/actions/workflows/ci.yml)
[![Codacy Grade](https://img.shields.io/codacy/grade/f7fa1461627e47bcb1db24cca8de4963)](https://www.codacy.com/gh/rx-ts/types)
[![type-coverage](https://img.shields.io/badge/dynamic/json.svg?label=type-coverage&prefix=%E2%89%A5&suffix=%&query=$.typeCoverage.atLeast&uri=https%3A%2F%2Fraw.githubusercontent.com%2Frx-ts%2Ftypes%2Fmaster%2Fpackage.json)](https://github.com/plantain-00/type-coverage)
[![GitHub release](https://img.shields.io/github/release/rx-ts/types)](https://github.com/rx-ts/types/releases)
[![David Dev](https://img.shields.io/david/dev/rx-ts/types.svg)](https://david-dm.org/rx-ts/types?type=dev)

[![Conventional Commits](https://img.shields.io/badge/conventional%20commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
[![changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/atlassian/changesets)

> TypeScript Type Definitions same as DefinitelyTyped.

- [Install](#install)
- [Usage](#usage)
- [Link to `@types` Automatically](#link-to-types-automatically)
- [Prefer Configuring Manually](#prefer-configuring-manually)
- [Changelog](#changelog)
- [License](#license)

## Install

```sh
# yarn
yarn add -D @d-ts/core

# npm
npm i -D @d-ts/core
```

## Usage

### Link to `@types` Automatically

```sh
# yarn
yarn add -D @d-ts/bin

# npm
npm i -D @d-ts/bin
```

```jsonc
// package.json
{
"scripts": {
"postinstall": "t"
}
}
```

### Prefer Configuring Manually

```jsonc
// tsconfig.json
{
"compilerOptions": {
"baseUrl": ".",
"typeRoots": ["./node_modules/@types", "./node_modules/@d-ts"]
}
}
```

## Changelog

Detailed changes for each release are documented in [CHANGELOG.md](./CHANGELOG.md).

## License

[MIT][] © [JounQin][]@[1stG.me][]

[1stg.me]: https://www.1stg.me
[jounqin]: https://GitHub.com/JounQin
[mit]: http://opensource.org/licenses/MIT