Skip to content

Commit

Permalink
chore: add readme note on use of any type
Browse files Browse the repository at this point in the history
  • Loading branch information
@Shadouts @bucko13
Shadouts authored and bucko13 committed Nov 6, 2023
1 parent 59aa99e commit 48551b9
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,16 @@ for more details on messages.

## Developers

#### A quick note on types

This library has been ported to TypeScript. The process unearthed quite a few
cases of bad typing. In many cases, the type may be a complex union of other
types. For now, these types have been defined as `any`, however please note that
the use of `any` is not best practice and should be removed in the future. This
will require some type refactoring.

### Setup

Developers who want to work on this library should clone the source
code and install dependencies:

Expand Down

0 comments on commit 48551b9

Please sign in to comment.