Skip to content

Commit

Permalink
chore: updated readme badges
Browse files Browse the repository at this point in the history
  • Loading branch information
Goldziher committed Sep 15, 2023
1 parent 24884af commit 025e9e1
Showing 1 changed file with 15 additions and 11 deletions.
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
![Tests](https://github.com/tool-belt/type-predicates/actions/workflows/main.yaml/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-guards&metric=coverage)](https://sonarcloud.io/dashboard?id=tool-belt_type-guards)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-guards&metric=alert_status)](https://sonarcloud.io/dashboard?id=tool-belt_type-guards)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-guards&metric=security_rating)](https://sonarcloud.io/dashboard?id=tool-belt_type-guards)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-guards&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=tool-belt_type-guards)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-guards&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=tool-belt_type-guards)
<div align="center">

![CI](https://github.com/tool-belt/type-predicates/actions/workflows/main.yaml/badge.svg)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-predicates&metric=coverage)](https://sonarcloud.io/summary/new_code?id=tool-belt_type-predicates)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-predicates&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=tool-belt_type-predicates)
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-predicates&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=tool-belt_type-predicates)
[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-predicates&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=tool-belt_type-predicates)
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tool-belt_type-predicates&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=tool-belt_type-predicates)

</div>

# @tool-belt/type-predicates

Expand All @@ -17,10 +21,10 @@ npm install @tool-belt/type-predicates

This package includes the following:

- a comprehensive collection of performant and flexible type-guards, that can function as a drop-in replacement for
the type-guards included in the NodeJS builtin `utils/types` module - with better significantly typing.
- a comprehensive collection of type assertions covering all type-guards included in the package.
- `isUnion`, `createTypeGuard` and `createTypeAssertion` utilities for the composition of type-guards and assertions.
- supports ES modules and tree shaking, i.e., works great with module bundlers such as Webpack for the browser.
- a comprehensive collection of performant and flexible type-guards, that can function as a drop-in replacement for
the type-guards included in the NodeJS builtin `utils/types` module - with better significantly typing.
- a comprehensive collection of type assertions covering all type-guards included in the package.
- `isUnion`, `createTypeGuard` and `createTypeAssertion` utilities for the composition of type-guards and assertions.
- supports ES modules and tree shaking, i.e., works great with module bundlers such as Webpack for the browser.

See the [docs](https://tool-belt.github.io/type-predicates/) for details.

0 comments on commit 025e9e1

Please sign in to comment.