@rzl-zone/ts-types-plus
v0.1.0
Published
A lightweight, modern collection of TypeScript types and interfaces to enhance type safety and improve code maintainability.
Maintainers
Readme
- 💻 Requirements
- ⚙️ Installation
- ✨ Features
- 💎 Detailed Features
- 🔥 Usage
- ❤️ Sponsor
- 📜 Changelog
- 🤝 Contributing
- 🔒 Security
- 🙌 Credits
- 📄 License
Node.js
≥18.18.0
This package uses modern TypeScript features, so Node.js 18.18.0 or higher is required.Supported environments:
- ✅ Node.js (18.18.0+).
- ✅ TypeScript (5.9.0+).
- ✅ Modern browsers (via bundlers like Webpack / Vite).
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.jsonminimum supports"target": "es2022"and"module": "es2022"or higher also set"strict": truefor full compatibility. Lower targets or strict is false, may cause type issues (likeany).
With NPM
npm install @rzl-zone/ts-types-plus@latestWith Yarn
yarn add @rzl-zone/ts-types-plus@latestWith PNPM
pnpm add @rzl-zone/ts-types-plus@latest- 📝 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.
For now, explore the examples or dive into the source — all utilities are documented via TSDoc and typed properly.
import type { | } from "@rzl-zone/ts-types-plus";Place your cursor inside { } then press Ctrl+Space to see all available types with full TSDoc hints.
Make TypeScript & VSCode automatically provide autocomplete for @rzl-zone/ts-types-plus without needing triple-slash references in every file:
1️⃣ Install @rzl-zone/ts-types-plus.
Make sure the package is installed:
npm install @rzl-zone/ts-types-plus # or yarn add @rzl-zone/ts-types-plus # or pnpm add @rzl-zone/ts-types-plus
2️⃣ Create a types folder.
Inside your project root, make a folder called
types:project-root/ ├─ src/ ├─ types/ │ └─ index.d.ts └─ tsconfig.json
3️⃣ Add the global reference file.
Create
types/index.d.tswith this content:/// <reference types="@rzl-zone/ts-types-plus" />- This tells TypeScript to include the types from
@rzl-zone/ts-types-plusglobally. - You can add more references here if needed, for example:
/// <reference types="@rzl-zone/ts-types-plus" /> // eg more references (if needed): /// <reference types="node" /> /// <reference types="react" />- This tells TypeScript to include the types from
4️⃣ Update tsconfig.json.
Make sure not to override "types" (or leave it empty) so TypeScript automatically picks up your types folder:
// tsconfig.json { "compilerOptions": { "strict": true, "typeRoots": ["./types", "./node_modules/@types"], // other your config... }, "include": ["src", "types"], // other your config... }typeRootstells TS where to look for global type definitions.- The
typesfolder comes first, so your references override or add to the default@typespackages.
Now, all types from @rzl-zone/ts-types-plus are globally available, and you don’t need "types": ["@rzl-zone/ts-types-plus"] in tsconfig.json.
Easy to use, just import on your code base.
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<OtherType, "omittingProps">;
// ➔ MyType = { includeProps: string; }Help support development:
👉 Become a sponsor.
See CHANGELOG.
See CONTRIBUTING.
Please report issues to [email protected].
- Rzl App.
- All Contributors.
The MIT License (MIT).
Please see License File for more information.
✅ Enjoy using @rzl-zone/ts-types-plus?
Star this repo ⭐ and share it with other TypeScript developers!
