Type Utils ❇️

Version 1.1.0

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>()
• ESLint
• 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 type-utils.d.ts file at the root of your project. Please make sure to add it in the array of the "include" property in your tsconfig.json.

{
	"compilerOptions": {
		...
	},
	"include": [ ..., "type-utils.d.ts" ],
}

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

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

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

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.

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 [email protected] to disclose any security vulnerabilities.

Made with ☕