Package Exports
- @alessiofrittoli/type-utils
- @alessiofrittoli/type-utils/dist/index.js
- @alessiofrittoli/type-utils/dist/index.mjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@alessiofrittoli/type-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Type Utils ❇️
Lightweight TypeScript types utilities
Table of Contents
Getting started
Run the following command to start using type-utils in your projects:
npm i @alessiofrittoli/type-utilsor using pnpm
pnpm i @alessiofrittoli/type-utilsThis 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.jsDevelopment
Install depenendencies
npm installor using pnpm
pnpm iBuild the source code
Run the following command to test and build code for distribution.
pnpm buildESLint
warnings / errors check.
pnpm lintContributing
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 security@alessiofrittoli.it to disclose any security vulnerabilities.
Made with ☕
|
|
|