Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xunnamius/typescript-utils
🆎 Various constants, utility types, and typed functions for improved TypeScript DX
https://github.com/xunnamius/typescript-utils
ergodark helper next ts type types typescript utility xunnamius
Last synced: 6 days ago
JSON representation
🆎 Various constants, utility types, and typed functions for improved TypeScript DX
- Host: GitHub
- URL: https://github.com/xunnamius/typescript-utils
- Owner: Xunnamius
- License: mit
- Created: 2021-04-24T12:47:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-28T00:10:18.000Z (2 months ago)
- Last Synced: 2024-10-20T10:52:38.387Z (19 days ago)
- Topics: ergodark, helper, next, ts, type, types, typescript, utility, xunnamius
- Language: JavaScript
- Homepage: https://npm.im/@-xun/types
- Size: 2.51 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
[![Black Lives Matter!][badge-blm]][link-blm]
[![Last commit timestamp][badge-last-commit]][link-repo]
[![Open issues][badge-issues]][link-issues]
[![Pull requests][badge-pulls]][link-pulls]
[![Uses Semantic Release!][badge-semantic-release]][link-semantic-release]
# typescript-utils (@-xun/types)
This monorepo contains generic utility types and helper functions for use in a
variety of TypeScript projects.
Before coming to this package to create new types, ensure your use case is not
covered by [type-fest][1], [Next.js itself][2], [MongoDB's Node.js driver][12],
or [TypeScript itself][3].
## Install
**@-xun/types**: for general TypeScript utilities:
```bash
npm install --save-dev @-xun/types
```
**@-xun/types/next**: for [next][4]-specific TypeScript utilities:
```bash
npm install --save-dev @-xun/types/next
```
**@-xun/types/jest**: for [jest][9]-specific TypeScript utilities:
```bash
npm install --save-dev @-xun/types/jest
```
## Usage
You can use this library's exports in your TypeScript projects like so:
```TypeScript
import type { HttpStatusCode } from '@-xun/types'
const status: HttpStatusCode = 404;
```
## Documentation
See the docs for information on the types they make available and
further documentation.
### License
[![FOSSA analysis][badge-fossa]][link-fossa]
## Contributing and Support
**[New issues][choose-new-issue] and [pull requests][pr-compare] are always
welcome and greatly appreciated! 🤩** Just as well, you can [star 🌟 this
project][link-repo] to let me know you found it useful! ✊🏿 Thank you!
See [CONTRIBUTING.md][contributing] and [SUPPORT.md][support] for more
information.
[badge-blm]: https://xunn.at/badge-blm 'Join the movement!'
[link-blm]: https://xunn.at/donate-blm
[link-repo]: https://github.com/xunnamius/typescript-utils
[badge-last-commit]:
https://img.shields.io/github/last-commit/xunnamius/typescript-utils
'Latest commit timestamp'
[badge-issues]:
https://img.shields.io/github/issues/Xunnamius/typescript-utils
'Open issues'
[link-issues]: https://github.com/Xunnamius/typescript-utils/issues?q=
[badge-pulls]:
https://img.shields.io/github/issues-pr/xunnamius/typescript-utils
'Open pull requests'
[link-pulls]: https://github.com/xunnamius/typescript-utils/pulls
[badge-fossa]:
https://app.fossa.com/api/projects/custom%2B27276%2Fgit%40github.com%3AXunnamius%2Ftypescript-utils.git.svg?type=large
"Analysis of this package's license obligations"
[link-fossa]:
https://app.fossa.com/projects/custom+27276%[email protected]:Xunnamius%2Ftypescript-utils.git
[badge-semantic-release]:
https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
'This repo practices continuous integration and deployment!'
[link-semantic-release]: https://github.com/semantic-release/semantic-release
[choose-new-issue]:
https://github.com/xunnamius/typescript-utils/issues/new/choose
[pr-compare]: https://github.com/xunnamius/typescript-utils/compare
[contributing]: CONTRIBUTING.md
[support]: .github/SUPPORT.md
[1]: https://github.com/sindresorhus/type-fest
[2]: https://nextjs.org/docs/basic-features/typescript
[3]: https://github.com/sindresorhus/type-fest#built-in-types
[4]: https://github.com/vercel/next.js
[9]: https://www.npmjs.com/package/jest
[12]: https://docs.mongodb.com/drivers/node/current/fundamentals/typescript/