Skip to content

Commit

Permalink
Refactor TypeScript definition to CommonJS compatible export (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
BendingBender authored and sindresorhus committed Apr 4, 2019
1 parent 254cdab commit 1051a46
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 14 deletions.
25 changes: 21 additions & 4 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,21 @@
/**
* Measure the difference between two strings.
*/
export default function leven(left: string, right: string): number;
declare const leven: {
/**
Measure the difference between two strings.
@example
```
import leven = require('leven');
leven('cat', 'cow');
//=> 2
```
*/
(left: string, right: string): number;

// TODO: Remove this for the next major release, refactor the whole definition to:
// declare function leven(left: string, right: string): number;
// export = leven;
default: typeof leven;
};

export = leven;
1 change: 1 addition & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -73,4 +73,5 @@ const leven = (left, right) => {
};

module.exports = leven;
// TODO: Remove this for the next major release
module.exports.default = leven;
4 changes: 2 additions & 2 deletions index.test-d.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {expectType} from 'tsd-check';
import leven from '.';
import {expectType} from 'tsd';
import leven = require('.');

expectType<number>(leven('kitten', 'sitting'));
16 changes: 8 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"node": ">=6"
},
"scripts": {
"test": "xo && ava && tsd-check",
"test": "xo && ava && tsd",
"bench": "matcha bench.js"
},
"files": [
Expand Down Expand Up @@ -41,17 +41,17 @@
"matching"
],
"devDependencies": {
"ava": "^1.3.1",
"fast-levenshtein": "^2.0.5",
"ava": "^1.4.1",
"fast-levenshtein": "^2.0.6",
"ld": "^0.1.0",
"levdist": "^2.0.0",
"levenshtein": "^1.0.4",
"levenshtein-component": "0.0.1",
"levenshtein-edit-distance": "^2.0.0",
"levdist": "^2.2.9",
"levenshtein": "^1.0.5",
"levenshtein-component": "^0.0.1",
"levenshtein-edit-distance": "^2.0.3",
"matcha": "^0.7.0",
"natural": "^0.6.3",
"talisman": "^0.21.0",
"tsd-check": "^0.3.0",
"tsd": "^0.7.2",
"xo": "^0.24.0"
}
}

0 comments on commit 1051a46

Please sign in to comment.