From 6eafee412d40b91fbaa728ccd9aab5844b9fe4bf Mon Sep 17 00:00:00 2001 From: Daniel Byrne Date: Fri, 14 Sep 2018 09:33:08 -0700 Subject: [PATCH] adds typings for the 'memdown' package (#28832) --- types/memdown/index.d.ts | 20 ++++++++++++++++++++ types/memdown/memdown-tests.ts | 16 ++++++++++++++++ types/memdown/tsconfig.json | 23 +++++++++++++++++++++++ types/memdown/tslint.json | 3 +++ 4 files changed, 62 insertions(+) create mode 100644 types/memdown/index.d.ts create mode 100644 types/memdown/memdown-tests.ts create mode 100644 types/memdown/tsconfig.json create mode 100644 types/memdown/tslint.json diff --git a/types/memdown/index.d.ts b/types/memdown/index.d.ts new file mode 100644 index 0000000000..ab7b8dfe36 --- /dev/null +++ b/types/memdown/index.d.ts @@ -0,0 +1,20 @@ +// Type definitions for memdown 3.0 +// Project: https://github.com/Level/memdown +// Definitions by: Meirion Hughes +// Daniel Byrne +// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped +// TypeScript Version: 2.3 + +import { AbstractLevelDOWN } from 'abstract-leveldown'; + +export interface MemDown extends AbstractLevelDOWN {} + +export interface MemDownConstructor { + // tslint:disable-next-line no-unnecessary-generics + new (): MemDown; + // tslint:disable-next-line no-unnecessary-generics + (): MemDown; +} + +export const MemDown: MemDownConstructor; +export default MemDown; diff --git a/types/memdown/memdown-tests.ts b/types/memdown/memdown-tests.ts new file mode 100644 index 0000000000..f93a4bb779 --- /dev/null +++ b/types/memdown/memdown-tests.ts @@ -0,0 +1,16 @@ +import MemDown from 'memdown'; + +const test = (db: MemDown) => { + db.open(() => { + db.put("key", "value", (err?: Error) => { }); + db.get("key", (err?: Error) => { }); + db.get("key", (err: Error | undefined, value: string) => { }); + db.close(() => {}); + }); +}; + +// doesn't need `new` and can be called as a function +test(new MemDown()); +test(new MemDown()); +test(MemDown()); +test(MemDown()); diff --git a/types/memdown/tsconfig.json b/types/memdown/tsconfig.json new file mode 100644 index 0000000000..dd3aa17b6c --- /dev/null +++ b/types/memdown/tsconfig.json @@ -0,0 +1,23 @@ +{ + "compilerOptions": { + "module": "commonjs", + "lib": [ + "es6" + ], + "noImplicitAny": true, + "noImplicitThis": true, + "strictNullChecks": true, + "strictFunctionTypes": true, + "baseUrl": "../", + "typeRoots": [ + "../" + ], + "types": [], + "noEmit": true, + "forceConsistentCasingInFileNames": true + }, + "files": [ + "index.d.ts", + "memdown-tests.ts" + ] +} \ No newline at end of file diff --git a/types/memdown/tslint.json b/types/memdown/tslint.json new file mode 100644 index 0000000000..256ee54775 --- /dev/null +++ b/types/memdown/tslint.json @@ -0,0 +1,3 @@ +{ + "extends": "dtslint/dt.json" +}