Skip to content

Commit

Permalink
chore(release): v1.33.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ashgw committed Apr 26, 2024
1 parent 13af9f4 commit e2e164e
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 5 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Collection of utility types and decorators to bullet proof TypeScript even more.
[![@latest](https://img.shields.io/npm/v/ts-roids.svg)](https://www.npmjs.com/package/ts-roids)
[![npm downloads](https://img.shields.io/npm/dm/ts-utils.svg)](https://www.npmjs.com/package/ts-roids)
[![bundle size](https://img.shields.io/bundlephobia/minzip/utility-types.svg)](https://www.npmjs.com/package/ts-roids)
<hr/><br/>
<hr/>
</div>

### Installation
Expand All @@ -20,7 +20,7 @@ npm i ts-roids
```bash
pnpm i ts-roids
```
If you're only using types, you can install it as a dev dependency.
If you're only using types, you can install it as a ``devDependency``.
And if you're using the decorators, set this property inside `tsconfig.json`.
```json
{
Expand Down Expand Up @@ -91,7 +91,7 @@ type ResultType = TestType<Type1, Type2, true>;
```
``TestType`` accepts three arguments: the types you're comparing (``Type1`` and ``Type2``) and a boolean (``true`` if you expected them to match, ``false`` otherwise). The resulting type will tell if your expectation is correct, true if it is, else false.

You can use it however you want, maybe to test a type with your eyes real quick, or,
You can use it however you want, maybe to test a type on the go, or,
test using a testing framework. Here's an example with [`vitest`](https://vitest.dev)

````ts
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "ts-roids",
"version": "1.32.0",
"version": "1.33.0",
"private": false,
"description": "Bullet-proof TS even more",
"keywords": [
Expand Down Expand Up @@ -103,4 +103,4 @@
"vitest": "1.5.0"
},
"packageManager": "[email protected]"
}
}

0 comments on commit e2e164e

Please sign in to comment.