Skip to content

Commit

Permalink
Require Node.js 8, add TypeScript definition (#6)
Browse files Browse the repository at this point in the history
  • Loading branch information
BendingBender authored and sindresorhus committed Apr 30, 2019
1 parent 69c4c83 commit 5489653
Show file tree
Hide file tree
Showing 7 changed files with 37 additions and 14 deletions.
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
* text=auto
*.js text eol=lf
* text=auto eol=lf
3 changes: 2 additions & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
language: node_js
node_js:
- '12'
- '10'
- '8'
- '6'
16 changes: 16 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/**
Lowercase the keys of an object.
@returns A new object with the keys lowercased.
@example
```
import lowercaseKeys = require('lowercase-keys');
lowercaseKeys({FOO: true, bAr: false});
//=> {foo: true, bar: false}
```
*/
declare function lowercaseKeys<T extends unknown>(object: {[key: string]: T}): {[key: string]: T};

export = lowercaseKeys;
6 changes: 3 additions & 3 deletions index.js
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
'use strict';
module.exports = object => {
const ret = {};
const result = {};

for (const [key, value] of Object.entries(object)) {
ret[key.toLowerCase()] = value;
result[key.toLowerCase()] = value;
}

return ret;
return result;
};
5 changes: 5 additions & 0 deletions index.test-d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import {expectType} from 'tsd';
import lowercaseKeys = require('.');

expectType<{[key: string]: boolean}>(lowercaseKeys({FOO: true, bAr: false}));
expectType<{[key: string]: string | number}>(lowercaseKeys({foo: 'bar', baz: 1}));
12 changes: 7 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,14 @@
"url": "sindresorhus.com"
},
"engines": {
"node": ">=6"
"node": ">=8"
},
"scripts": {
"test": "xo && ava"
"test": "xo && ava && tsd"
},
"files": [
"index.js"
"index.js",
"index.d.ts"
],
"keywords": [
"object",
Expand All @@ -30,7 +31,8 @@
"key"
],
"devDependencies": {
"ava": "*",
"xo": "*"
"ava": "^1.4.1",
"tsd": "^0.7.2",
"xo": "^0.24.0"
}
}
6 changes: 3 additions & 3 deletions test.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import test from 'ava';
import m from '.';
import lowercaseKeys from '.';

test('main', t => {
t.true(m({FOO: true}).foo);
t.true(m({FOO: true, bAr: true}).bar);
t.true(lowercaseKeys({FOO: true}).foo);
t.true(lowercaseKeys({FOO: true, bAr: true}).bar);
});

0 comments on commit 5489653

Please sign in to comment.