Skip to content

Commit

Permalink
docs: section headers (#43)
Browse files Browse the repository at this point in the history
  • Loading branch information
jly36963 committed Oct 6, 2023
1 parent 673e53d commit 2301931
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ main()
npm install string-ts
```

## 👌 Supported TypeScript Versions
## 👌 Supported TypeScript versions

`string-ts` currently only works on TypeScript v5+.

Expand Down Expand Up @@ -721,7 +721,7 @@ const result = deepSnakeKeys(data)
// ^ { 'hello_world': { 'foo_bar': 'baz' } }
```

## Type Utilities
## Type utilities

All the functions presented in this API have associated type counterparts.

Expand All @@ -737,7 +737,7 @@ Lowercase<'HELLO WORLD'> // 'hello world'
Uppercase<'hello world'> // 'HELLO WORLD'
```

### General Type utilities from this library
### General type utilities from this library

```ts
St.CharAt<'hello world', 6> // 'w'
Expand Down Expand Up @@ -850,6 +850,6 @@ const result = deepTransformKeys(data, toUpperCase) as MyType<typeof data>
// ^ { 'HELLOWORLD': 'baz' }
```

## 🫶 Aknowledgements
## 🫶 Acknowledgements

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 2301931

Please sign in to comment.