Skip to content

Commit c345b4c

Browse files
Add TypeScript type definitions
1 parent b3710c4 commit c345b4c

File tree

3 files changed

+33
-6
lines changed

3 files changed

+33
-6
lines changed

index.d.ts

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
/**
2+
Decodes a Uniform Resource Identifier (URI) component previously created by `encodeURIComponent()`
3+
or by a similar routine.
4+
5+
@param encodedURI - An encoded component of a URI.
6+
7+
@returns The decoded URI component.
8+
9+
@example
10+
```
11+
decodeUriComponent('st%C3%A5le')
12+
//=> 'ståle'
13+
```
14+
*/
15+
export default function decodeUriComponent(encodedURI: string): string;

index.test-d.ts

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
import {expectType} from 'tsd';
2+
import decodeUriComponent from './index.js';
3+
4+
expectType<string>(decodeUriComponent('st%C3%A5le'));

package.json

+14-6
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,21 @@
99
"email": "[email protected]",
1010
"url": "github.com./SamVerschueren"
1111
},
12+
"type": "module",
13+
"exports": {
14+
"types": "./index.d.ts",
15+
"default": "./index.js"
16+
},
1217
"engines": {
1318
"node": ">=14.16"
1419
},
1520
"scripts": {
16-
"test": "xo && nyc ava",
21+
"test": "xo && nyc ava && tsd",
1722
"coveralls": "nyc report --reporter=text-lcov | coveralls"
1823
},
19-
"type": "module",
20-
"exports": {
21-
"default": "./index.js"
22-
},
2324
"files": [
24-
"index.js"
25+
"index.js",
26+
"index.d.ts"
2527
],
2628
"keywords": [
2729
"decode",
@@ -36,6 +38,12 @@
3638
"ava": "^5.1.0",
3739
"coveralls": "^3.1.1",
3840
"nyc": "^15.1.0",
41+
"tsd": "^0.25.0",
3942
"xo": "^0.53.1"
43+
},
44+
"tsd": {
45+
"compilerOptions": {
46+
"module": "node16"
47+
}
4048
}
4149
}

0 commit comments

Comments
 (0)