@alessiofrittoli/type-utils

Type Utils ❇️

Lightweight TypeScript types utilities

Table of Contents

• Getting started
• Utility types
  • ValueOf
  • ValueOfKey
  • OptionalKey
  • Writeable
  • RenameKey
  • ArgumentTypes
• Extenders types
  • JSON
    • JSON.stringify<T>()
    • JSON.parse<T>()
  • Body
    • Body.json<T>()
• Development
  • Install depenendencies
  • Build the source code
  • ESLint
• Contributing
• Security
• Credits

---

Getting started

Run the following command to start using type-utils in your projects:

npm i @alessiofrittoli/type-utils

or using pnpm

pnpm i @alessiofrittoli/type-utils

This tiny library defines some global types which are not imported in your IDE by default.
After installation a postinstall script is executed to create the alessiofrittoli-env.d.ts file at the root of your project. This script will try to update your tsconfig.json file.

If that fail, please, make sure to add alessiofrittoli-env.d.ts in the array of the "include" property in your tsconfig.json.

{
    "compilerOptions": {
        ...
    },
    "include": [ ..., "alessiofrittoli-env.d.ts" ],
}

You can skip this process if *.ts is already in your "include" array.

⚠️ If the alessiofrittoli-env.d.ts file creation fails you can run the following command to manually execute the script:

node node_modules/@alessiofrittoli/type-utils/scripts/postinstall/index.js

---

Development

Install depenendencies

npm install

or using pnpm

pnpm i

Build the source code

Run the following command to test and build code for distribution.

pnpm build

ESLint

warnings / errors check.

pnpm lint

---

Contributing

Contributions are truly welcome!

Please refer to the Contributing Doc for more information on how to start contributing to this project.

Help keep this project up to date with GitHub Sponsor.

---

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and NOT open a public issue. We will investigate all legitimate reports. Email [e-mail] to disclose any security vulnerabilities.

Made with ☕

Alessio Frittoli https://alessiofrittoli.it | [e-mail]