Compare commits

...

2 Commits

Author SHA1 Message Date
Jeff 5a93eb97b3 Add an index file 2024-02-28 23:33:03 -05:00
Jeff 3e14a77a5e Okay, someone else made something called numeric-types already 2024-02-28 23:05:12 -05:00
3 changed files with 10 additions and 5 deletions

View File

@ -1,20 +1,22 @@
# Numeric Types
# Math Types
A typescript library that aims to provide performant arithmetic types.
# Limitations
Currently numeric-types does not support negative numbers, decimals, or bigints.
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

3
index.ts Normal file
View File

@ -0,0 +1,3 @@
export * from './src/Addition'
export * from './src/Max'
export * from './src/Digits'

View File

@ -1,6 +1,6 @@
{
"name": "numeric-types",
"version": "0.0.1",
"name": "math-types",
"version": "0.0.2",
"description": "",
"main": "index.js",
"scripts": {
@ -11,5 +11,5 @@
"dependencies": {
"typescript": "^5.3.3"
},
"keywords": ["typescript", "math", "numeric", "add", "max"]
"keywords": ["typescript", "math", "add", "max"]
}