math-types/README.md

27 lines
555 B
Markdown

# Math Types
A typescript library that aims to provide performant arithmetic types.
# Limitations
Currently math-types does not support negative numbers, decimals, or bigints.
# Types
### Add<A extends number, B extends number>
Resolves to the sum of A and B
The corresponding function `add` uses this type
### Max<A extends number, B extends number>
Resolves to the larger of A and B
The corresponding function `max` uses this type
# Current Roadmap
- Subtraction
- Support negative numbers
- Support decimal numbers
- Multiplication
- Division