Skip to content

Commit

Permalink
chore: Update README.md to include supported TS versions (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
gustavoguichard authored Oct 5, 2023
1 parent 738811a commit 32a2d06
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ TypeScript yields the best static analysis when types are highly specific.
Literals are more specific than type `string`.
This library preserves literals (and unions of literals) after transformations, unlike most existing utility libraries (and built-in string methods.)

## In-depth example
### In-depth example

In the below example, I want to get a strongly-typed, camel-case version of `process.env`.
One flow results in a loose type, and the other results in a more precise type.
Expand Down Expand Up @@ -82,6 +82,11 @@ main()
npm install string-ts
```

## 👌 Supported TypeScript Versions
`string-ts` currently only works on TypeScript v5+.

It also only work with common ASCII characters characters. We don't plan to support international characters or emojis.

---

# 📖 API
Expand Down Expand Up @@ -812,10 +817,6 @@ const result = deepTransformKeys(data, toUpperCase) as MyType<typeof data>
// ^ { 'HELLOWORLD': 'baz' }
```

## Disclaimer

We don't plan to support international characters.

## Aknowledgements
## 🫶 Aknowledgements

This library got a lot of inspiration from libraries such as [lodash](https://github.com/lodash/lodash), [ts-reset](https://github.com/total-typescript/ts-reset), [type-fest](https://github.com/sindresorhus/type-fest), [HOTScript](https://github.com/gvergnaud/hotscript), and many others.

0 comments on commit 32a2d06

Please sign in to comment.