TS Types Plus
A lightweight, modern collection of TypeScript types and interfaces for Node.js & browser projects (via bundlers like Webpack, Turbopack, Rollup, esbuild, and higher-level tools like Vite, tsup and tsdown).
Provides reusable types to enhance type safety and improve code maintainability.
Built with β€οΈ by @rzl-zone.
---
π Table of Contents
- π» [Requirements](#requirements)
- βοΈ [Installation](#installation)
- β¨ [Features](#features)
- π [Detailed Features](#detailed-features)
- [Full Documentation](#detailed-features--full-documentation)
- [Hint Autocomplete](#detailed-features--hint-autocomplete-setup)
- π₯ [Usage](#usage)
- β€οΈ [Sponsor](#sponsor-this-package)
- π [Changelog](#changelog)
- π€ [Contributing](#contributing)
- π [Security](#security)
- π [Credits](#credits)
- π [License](#license)
---
π» Requirements
- **Node.js `β₯18.18.0`**
This package uses modern TypeScript features, so Node.js 18.18.0 or higher is required.
- **Minimum supported environments \***(recommended)**\*:**
- β
Node.js (18.18.0+).
- β
TypeScript (5.9.0+).
- β
Modern browsers (via **ESM-compatible** bundlers such as [`Webpack`](https://webpack.js.org/), [`Turbopack`](https://vercel.com/blog/turbopack), [`Rollup`](https://rollupjs.org/), [`esbuild`](https://esbuild.github.io/), and higher-level tools like [`Vite`](https://vite.dev/), [`tsup`](https://tsup.egoist.dev/), and [`tsdown`](https://tsdown.dev/)).
- **Recommended minimum `tsconfig` settings for full TypeScript support:**
- `"strict": true`
- `"target": "es2022"`
- `"module": "es2022"`
> β οΈ **Note:**
>
> - If youβre using TypeScript and compiling from source, make sure your `tsconfig.json` minimum supports `"target": "es2022"` and `"module": "es2022"` or higher also set `"strict": true` for full compatibility.
> - Lower targets or strict is false, may cause type issues (like `any`).
---
βοΈ Installation
#### *With NPM*
```bash
npm install @rzl-zone/ts-types-plus@latest
```
#### *With Yarn*
```bash
yarn add @rzl-zone/ts-types-plus@latest
```
#### *With PNPM*
```bash
pnpm add @rzl-zone/ts-types-plus@latest
```
---
β¨ Features
- π Written in **TypeScript** β fully typed & type-safe.
- β‘ Lightweight & easy to include in projects.
- π¦ Compatible with **Node.js** & modern browsers (via bundlers).
- β€οΈ Designed for maintainable and readable code.
- 𧩠Contains useful TypeScript types like `OmitStrict`, `PartialOnly`, etc.
---
π Detailed Features
Full documentation TS Types Plus is
currently under construction ποΈ.
#### For now, explore the examples or dive into the source β all utilities are documented via **TSDoc** and typed properly.
```ts
import type {} from /* β¦ */ "@rzl-zone/ts-types-plus";
```
#### Place your cursor inside `{ }` then press Ctrl+Space (Windows/Linux) or Cmd+Space (macOS), or use your editorβs autocomplete shortcut, to see all available types with full TSDoc hints.
---
Hint: Autocomplete Setup (Step by Step).
Improve TypeScript editor import suggestions for `@rzl-zone/ts-types-plus`, so all functions, types, and modules appear instantly when triggering autocomplete β press `Ctrl+Space` (**Windows/Linux**), `β+Space` (**macOS**), or your editorβs autocomplete shortcut.
This works across modern TypeScript-supported editors (e.g., `VSCode`, `WebStorm`, `Vim extensions`, `NeoVim LSP`, `Cursor`) without requiring triple-slash references β the package is fully indexed automatically through your editorβs TypeScript language service, follow steps:
- 1οΈβ£ **Install @rzl-zone/ts-types-plus.**
- Make sure the package is installed, see [**Installation Guide**](#installation).
- 2οΈβ£ **Create a types folder.**
- Inside your project root, make a folder called `types`:
```pgsql
project-root/
ββ src/
ββ types/
β ββ index.d.ts
ββ tsconfig.json
ββ jsconfig.json
```
- 3οΈβ£ **Add the global reference file.**
- Create `types/index.d.ts` with this content:
```ts
///
```
- You can add more references here if needed, for example:
```ts
///
// eg more references (if needed):
///
///
```
- 4οΈβ£ **Update tsconfig.json.**
- Make sure add `types` folder to `"include"`, so **TypeScript** automatically picks up your types folder:
```jsonc
// tsconfig.json
{
"compilerOptions": {
"strict": true,
// other your config...
},
"include": ["src", "types"]
// other your config...
}
```
- 5οΈβ£ **Update jsconfig.json (for JavaScript projects).**
- If you also work with JS, do the same:
```jsonc
// jsconfig.json
{
"compilerOptions": {
"checkJs": true, // Optional, enables type checking
// other your config...
},
"include": ["src", "types"]
// other your config...
}
```
> βΉοΈ ***Tip:*** *For JS projects, consider adding `"checkJs": true` for better IntelliSense.*
- 6οΈβ£ **Restart your editor/IDE.**
- This forces your TypeScript language service to re-index the package.
- After restart, **all functions, types, and modules from `@rzl-zone/ts-types-plus` will appear instantly in autocomplete**.
---
π₯ Usage
### **Easy to use, just import on your code base.**
```ts
import type { OmitStrict } from "@rzl-zone/ts-types-plus";
type OtherType = {
includeProps: string;
omittingProps: string;
};
// Fully strict TS omit that requires the keys to exist in target
type MyType = OmitStrict;
// β MyType = { includeProps: string; }
```
---
**Help support development:**
***[π Become a sponsor](https://github.com/sponsors/rzl-app).***
---
π Changelog
**See [CHANGELOG](https://github.com/rzl-zone/rzl-zone/blob/main/packages/ts-types-plus/CHANGELOG.md).**
---
π€ Contributing
**See [CONTRIBUTING](https://github.com/rzl-zone/rzl-zone/blob/main/CONTRIBUTING.md).**
---
π Security
**Please report issues to [rzlzone.dev@gmail.com](mailto:rzlzone.dev@gmail.com).**
---
π Credits
**- [Rzl App](https://github.com/rzl-app).**
**- [All Contributors](https://github.com/rzl-zone/rzl-zone/graphs/contributors).**
---
π License
**The MIT License (MIT).**
*Please see **[License File](https://github.com/rzl-zone/rzl-zone/blob/main/LICENSE)** for more information.*
---
β
**Enjoy using `@rzl-zone/ts-types-plus`?**
*Star the monorepo [β](https://github.com/rzl-zone/rzl-zone) and share it with other JavaScript developers!*
π¦ Explore other packages under [`@rzl-zone`](https://github.com/rzl-zone/rzl-zone)
---
