https://github.com/lamualfa/common-dts
📘 Collection of reusable .d.ts files commonly used on your projects.
https://github.com/lamualfa/common-dts
declaration definition import type typescript
Last synced: 22 days ago
JSON representation
📘 Collection of reusable .d.ts files commonly used on your projects.
- Host: GitHub
- URL: https://github.com/lamualfa/common-dts
- Owner: lamualfa
- License: wtfpl
- Created: 2023-01-25T17:41:23.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-01-26T12:17:42.000Z (about 3 years ago)
- Last Synced: 2025-04-12T18:14:48.763Z (10 months ago)
- Topics: declaration, definition, import, type, typescript
- Homepage:
- Size: 24.4 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
No More Type Extension Error
Â
Â
# common-dts 
Collection of reusable `.d.ts` files commonly used on your projects. So you don't need to Google it again.
## Installation
###### NPM
```bash
npm i -D common-dts
```
###### PNPM
```bash
pnpm add -D common-dts
```
###### Yarn
```bash
yarn add -D common-dts
```
## Usage
### A. Globally
The entire project will affected when using this method. So, you don't need to importing the type again.
> **Don't want to affect the entire project?** Use [Locally](#b-locally) method for individual file configuration.
###### Format
Put this code on any `.d.ts` file on your project. Or you can create a new one if it doesn't exist.
```ts
declare global {
import "common-dts/types/";
}
```
See [Supported Extensions](#supported-extensions) for the list of available ``.
###### Example
```ts
declare global {
import "common-dts/types/module.css";
import "common-dts/types/module.scss";
import "common-dts/types/react/svg";
}
```
### B. Locally
Only file with the imported type will affected when using this method.
###### Format
```ts
import "common-dts/types/";
```
See [Supported Extensions](#supported-extensions) for the list of available ``.
###### Example
```ts
import "common-dts/types/module.scss";
// Now you can import your SCSS file without typing error
import classes from "./index.module.scss";
// Your code
```
## Supported Extensions
| Framework | Name | Extension | File Name |
| --------- | ------------------- | ----------------------------- | ------------------ |
| Any | CSS Module | `.module.css` | `module.css.d.ts` |
| Any | Sass or SCSS Module | `.module.scss` `.module.sass` | `module.scss.d.ts` |
| Any | AVIF | `.avif` | `avif.d.ts` |
| Any | Bitmap | `.bmp` | `bmp.d.ts` |
| Any | PNG | `.png` | `png.d.ts` |
| Any | JPG | `.jpg` `.jpeg` | `jpg.d.ts` |
| Any | GIF | `.gif` | `gif.d.ts` |
| Any | WEBP | `.webp` | `webp.d.ts` |
| React | SVG | `.svg` | `react/svg.d.ts` |
| Vue 2 | SVG | `.svg` | `vue2/svg.d.ts` |
| Vue 3 | SVG | `.svg` | `vue3/svg.d.ts` |
| Solid | SVG | `.svg` | `solid/svg.d.ts` |
| Svelte | SVG | `.svg` | `svelte/svg.d.ts` |