Skip to content

Commit 9ea682c

Browse files
committed
feat: add Typescript typings
1 parent 5004d72 commit 9ea682c

File tree

3 files changed

+18
-2
lines changed

3 files changed

+18
-2
lines changed

index.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
declare function parseDate(isoDate: string): Date | number | null
2+
declare function parseDate(isoDate: null | undefined): null
3+
export default parseDate

index.test-d.ts

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
import { expectType, expectError } from 'tsd'
2+
3+
import parse from '.'
4+
5+
expectType<Date | number | null>(parse('2010-12-11 09:09:04'))
6+
expectType<Date | number | null>(parse('infinity'))
7+
expectType<Date | number | null>(parse('garbage'))
8+
expectType<null>(parse(null))
9+
expectType<null>(parse(undefined))
10+
expectError(parse(1625042787))
11+
expectError(parse(new Date()))

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"node": ">=12"
1515
},
1616
"scripts": {
17-
"test": "standard && tape test.js"
17+
"test": "standard && tape test.js && tsd"
1818
},
1919
"keywords": [
2020
"postgres",
@@ -24,10 +24,12 @@
2424
"dependencies": {},
2525
"devDependencies": {
2626
"standard": "^16.0.0",
27-
"tape": "^5.0.0"
27+
"tape": "^5.0.0",
28+
"tsd": "^0.17.0"
2829
},
2930
"files": [
3031
"index.js",
32+
"index.d.ts",
3133
"readme.md"
3234
]
3335
}

0 commit comments

Comments
 (0)