Skip to content
This repository was archived by the owner on Dec 1, 2024. It is now read-only.

feat: restore typings + testing #499

Closed
wants to merge 1 commit into from
Closed

feat: restore typings + testing #499

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
* <a href="#events">Events</a>
* <a href="#extending">Extending LevelUP</a>
* <a href="#multiproc">Multi-process access</a>
* <a href="#typings">TypeScript </a>
* <a href="#support">Getting support</a>
* <a href="#contributing">Contributing</a>
* <a href="#license">Licence &amp; copyright</a>
Expand Down Expand Up @@ -475,6 +476,15 @@ Stores like LevelDB are thread-safe but they are **not** suitable for accessing

See the <a href="https://github.com/level/levelup/wiki/Modules"><b>wiki</b></a> for some LevelUP extensions, including [multilevel](https://github.com/juliangruber/multilevel), that may help if you require a single store to be shared across processes.

<a name="typings"></a>
TypeScript
----------

LevelUP comes with TypeScript definitions that can automatically infer options from a typed `abstract-leveldown` implementation.

See the <a href="https://github.com/Level/levelup/wiki/Typings"><b>wiki</b></a> for more information.


<a name="support"></a>
Getting support
---------------
Expand Down
96 changes: 96 additions & 0 deletions lib/levelup.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
import { EventEmitter } from 'events';
import * as levelerrors from 'level-errors';
import { AbstractLevelDOWN, AbstractIteratorOptions, Batch } from 'abstract-leveldown';

declare global {
namespace Level {
export interface UP<K, V, O, PO, GO, DO, IO, BO, TB> {
}
}
}

export interface LevelUp<K=any, V=any, O={}, PO={}, GO={}, DO={}, IO={}, BO={}, TB=Batch<K, V>>
extends Level.UP<K, V, O, PO, GO, DO, IO, BO, TB>,
EventEmitter {

open(): Promise<void>;
open(callback?: (err: any) => any): void;
close(): Promise<void>;
close(callback?: (err: any) => any): void;

put(key: K, value: V, options?: PO): Promise<void>;
put(key: K, value: V, options: PO, callback: (err: any) => any): void;
put(key: K, value: V, callback: (err: any) => any): void;

get(key: K, options?: GO): Promise<any>;
get(key: K, options: GO, callback: (err: any, value: any) => any): void;
get(key: K, callback: (err: any, value: any) => any): void;

del(key: K, options?: DO): Promise<void>
del(key: K, options: DO, callback: (err: any) => any): void;
del(key: K, callback: (err: any) => any): void;

batch(array: TB[], options?: BO): Promise<void>;
batch(array: TB[], options: BO, callback: (err?: any) => any): void;
batch(array: TB[], callback: (err?: any) => any): void;

batch(): LevelUpChain<K, V>;

isOpen(): boolean;
isClosed(): boolean;

createReadStream(options?: IO & AbstractIteratorOptions<K>): NodeJS.ReadableStream;
createKeyStream(options?: IO & AbstractIteratorOptions<K>): NodeJS.ReadableStream;
createValueStream(options?: IO & AbstractIteratorOptions<K>): NodeJS.ReadableStream;

/**emitted when a new value is 'put' */
on(event: 'put', cb: (key: K, value: V) => void): this
/**emitted when a value is deleted*/
on(event: 'del', cb: (key: K) => void)
/**emitted when a batch operation has executed */
on(event: 'batch', cb: (ary: any[]) => void)
/**emitted when the database has opened ('open' is synonym) */
on(event: 'ready', cb: () => void)
/**emitted when the database has opened */
on(event: 'open', cb: () => void)
/** emitted when the database has closed*/
on(event: 'closed', cb: () => void)
/** emitted when the database is opening */
on(event: 'opening', cb: () => void)
/** emitted when the database is closing */
on(event: 'closing', cb: () => void)
}

interface LevelUpConstructor {
<K=any, V=any, O=any, PO={}, GO={}, DO={}, IO={}, BO={}, B = Batch<K, V>>(
db: AbstractLevelDOWN<any, any, O, PO, GO, DO, IO, BO>,
options: O,
cb?: (err: Error) => void): LevelUp<K, V, O, PO, GO, DO, IO, BO, B>;
<K=any, V=any, O=any, PO={}, GO={}, DO={}, IO={}, BO={}, B = Batch<K, V>>(
db: AbstractLevelDOWN<any, any, O, PO, GO, DO, IO, BO>,
cb?: (err: Error) => void): LevelUp<K, V, O, PO, GO, DO, IO, BO, B>;

new <K=any, V=any, O=any, PO={}, GO={}, DO={}, IO={}, BO={}, B = Batch<K, V>>(
db: AbstractLevelDOWN<any, any, O, PO, GO, DO, IO, BO>,
options: O,
cb?: (err?: Error) => void): LevelUp<K, V, O, PO, GO, DO, IO, BO, B>;
new <K=any, V=any, O=any, PO={}, GO={}, DO={}, IO={}, BO={}, B = Batch<K, V>>(
db: AbstractLevelDOWN<any, any, O, PO, GO, DO, IO, BO>,
cb?: (err?: Error) => void): LevelUp<K, V, O, PO, GO, DO, IO, BO, B>;

errors: typeof levelerrors;
}

export interface LevelUpChain<K=any, V=any> {
readonly length: number;
put(key: K, value: V): this;
del(key: K): this;
clear(): this;
write(callback: (err?: any) => any): this;
write(): Promise<this>;
}

export var errors: typeof levelerrors;

declare const LevelUp: LevelUpConstructor;
export default LevelUp
17 changes: 11 additions & 6 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,37 +34,42 @@
"json"
],
"main": "lib/levelup.js",
"typings": "lib/levelup.d.ts",
"dependencies": {
"deferred-leveldown": "~2.0.2",
"level-errors": "~1.1.0",
"level-iterator-stream": "~2.0.0",
"xtend": "~4.0.0"
},
"devDependencies": {
"abstract-leveldown": "^2.7.0",
"@types/node": "^8.0.31",
"abstract-leveldown": "^2.7.1",
"after": "^0.8.2",
"async": "^2.5.0",
"bl": "^1.2.1",
"browserify": "^14.3.0",
"bustermove": "~1.0.0",
"delayed": "~1.0.1",
"encoding-down": "^2.2.0",
"encoding-down": "^2.3.1",
"faucet": "~0.0.1",
"leveldown": "^2.0.0",
"memdown": "^1.2.4",
"memdown": "^1.4.1",
"msgpack-js": "~0.3.0",
"referee": "~1.2.0",
"rimraf": "^2.6.1",
"safe-buffer": "^5.1.0",
"slow-stream": "0.0.4",
"standard": "^10.0.2",
"tape": "^4.7.0"
"tape": "^4.7.0",
"ts-node": "^3.3.0",
"typescript": "^2.5.2"
},
"scripts": {
"test": "standard && node test | faucet"
"test": "standard && node test | faucet && npm run ts-test",
"ts-test": "ts-node --no-cache test | faucet"
},
"engines": {
"node": ">=6.0.0"
},
"license": "MIT"
}
}
7 changes: 4 additions & 3 deletions test/common.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ var rimraf = require('rimraf')
var fs = require('fs')
var path = require('path')
var delayed = require('delayed').delayed
var levelup = require('../lib/levelup.js')

var levelup = require('../lib/levelup.js').default
var errors = require('level-errors')
var dbidx = 0
var leveldown = require('leveldown')
var encDown = require('encoding-down')
var leveldown = require('leveldown').default
var encDown = require('encoding-down').default

assert(levelup.errors === errors)

Expand Down
2 changes: 1 addition & 1 deletion test/create-stream-vs-put-racecondition.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var levelup = require('../lib/levelup.js').default
Copy link
Contributor

@huan huan Oct 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe this is not necessary because we had exported both LevelUP and default.

See:

levelup/lib/levelup.js

Line 294 in f93790f

module.exports = LevelUP.default = LevelUP

That will make sure the code will pass the following assertion:

const levelup1 = require('../lib/levelup.js')
const levelup2 = require('../lib/levelup.js').default

assert(levelup1 === levelup2)

Copy link
Member Author

@MeirionHughes MeirionHughes Oct 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Its down to typescript - you cannot have both export default and export = in the typings. So the typings have gone with the default export exclusively for typescript users.

It means when you run the normal js through the typescript compiler it will complain if you don't use the default

Copy link
Contributor

@huan huan Oct 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, understand.

Then how about we do a module.exports = LevelUP.default = LevelUP.LevelUP = LevelUP ?

Then we will be able to do a var { LevelUP } = require('../lib/levelup.js'), which would be better than require('...').default?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not a fan of require('...').default - but because it's only in the tests, I prefer it over more hacks in lib/levelup.js.

Copy link
Member Author

@MeirionHughes MeirionHughes Oct 4, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yeah I don't think we need more hacks to the export; Its just for the test here because we're pushing the (mostly) unadulterated js through the compiler. normal javascript users:

const levelup = require('levelup')

normal ts users:

import levelup from 'levelup'

you can always do const {default:levelup} = require('levelup'); but I suspect we might run into issues if we're still testing on an older node.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm ok with default too because it's just unit test script.

var common = require('./common')
var assert = require('referee').assert
var buster = require('bustermove')
Expand Down
6 changes: 3 additions & 3 deletions test/deferred-open-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var encDown = require('encoding-down')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var encDown = require('encoding-down').default
var async = require('async')
var common = require('./common')
var assert = require('referee').assert
Expand Down
4 changes: 2 additions & 2 deletions test/idempotent-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var common = require('./common')
var assert = require('referee').assert
var buster = require('bustermove')
Expand Down
4 changes: 2 additions & 2 deletions test/init-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var common = require('./common')
var assert = require('referee').assert
var refute = require('referee').refute
Expand Down
6 changes: 3 additions & 3 deletions test/inject-encoding-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var encDown = require('encoding-down')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var encDown = require('encoding-down').default
var async = require('async')
var common = require('./common')
var msgpack = require('msgpack-js')
Expand Down
6 changes: 3 additions & 3 deletions test/json-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var encDown = require('encoding-down')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var encDown = require('encoding-down').default
var async = require('async')
var common = require('./common')
var assert = require('referee').assert
Expand Down
6 changes: 3 additions & 3 deletions test/leveldown-substitution-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var levelup = require('../lib/levelup.js').default
var assert = require('referee').assert
var refute = require('referee').refute
var buster = require('bustermove')
var memdown = require('memdown')
var encDown = require('encoding-down')
var memdown = require('memdown').default
var encDown = require('encoding-down').default

require('./common')

Expand Down
6 changes: 3 additions & 3 deletions test/null-and-undefined-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var errors = levelup.errors
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var errors = require('../lib/levelup.js').errors
var common = require('./common')
var assert = require('referee').assert
var refute = require('referee').refute
Expand Down
4 changes: 2 additions & 2 deletions test/open-patchsafe-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var common = require('./common')
var assert = require('referee').assert
var refute = require('referee').refute
Expand Down
6 changes: 3 additions & 3 deletions test/read-stream-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
* MIT License <https://github.com/level/levelup/blob/master/LICENSE.md>
*/

var levelup = require('../lib/levelup.js')
var leveldown = require('leveldown')
var encDown = require('encoding-down')
var levelup = require('../lib/levelup.js').default
var leveldown = require('leveldown').default
var encDown = require('encoding-down').default
var common = require('./common')
var SlowStream = require('slow-stream')
var delayed = require('delayed')
Expand Down
8 changes: 8 additions & 0 deletions tsconfig.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"compilerOptions": {
"target": "es2015",
"moduleResolution": "node",
"checkJs": true,
"allowJs": true
}
}