libp2p-ts/memdown/index.d.ts

// Type definitions for LevelDown 3.0.0
// Project: https://github.com/level/memdown
// Definitions by: Thiago de Arruda <https://github.com/tarruda>
//                 Jaco Greeff <https://github.com/jacogr>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped

/// <reference types="node" />

declare module 'memdown' {
namespace memdown {
    type Bytes = string | Buffer;
    type ErrCallback = (error: any) => void;
    type ErrNumberCallback = (error: any, value: number) => void;
    type ErrBufferCallback = (error: any, value: Buffer) => void;
    type ErrStringCallback = (error: any, value: string) => void;
    type KeyAsStringCallback = (error: any, key: string, value: Buffer) => void;
    type ValueAsStringCallback = (error: any, key: Buffer, value: string) => void;
    type KeyAndValueAsStringCallback = (error: any, key: string, value: string) => void;
    type KeyAndValueAsBufferCallback = (error: any, key: Buffer, value: Buffer) => void;

    interface PutBatch {
        type: "put";
        key: Bytes;
        value: Bytes;
    }

    interface DelBatch {
        type: "del";
        key: Bytes;
    }

    type Batch = PutBatch | DelBatch;

    interface OpenOptions {
        createIfMissing?: boolean;
        errorIfExists?: boolean;
        compression?: boolean;
        cacheSize?: number;
    }

    interface OpenAdvancedOptions extends OpenOptions {
        writeBufferSize?: number;
        blockSize?: number;
        maxOpenFiles?: number;
        blockRestartInterval?: number;
        maxFileSize?: number;
    }

    interface WriteOptions {
        sync?: boolean;
    }

    interface ReadOptions {
        fillCache?: boolean;
    }

    interface BufferReadOptions extends ReadOptions {
        asBuffer?: true;
    }

    interface StringReadOptions extends ReadOptions {
        asBuffer: false;
    }

    interface IteratorOptions {
        gt?: Bytes;
        lt?: Bytes;
        gte?: Bytes;
        lte?: Bytes;
        reverse?: boolean;
        keys?: boolean;
        values?: boolean;
        limit?: number;
        fillCache?: boolean;
    }

    interface KeyAsStringIteratorOptions extends IteratorOptions {
        keyAsBuffer: false;
        valueAsBuffer?: true;
    }

    interface ValueAsStringIteratorOptions extends IteratorOptions {
        keyAsBuffer?: true;
        valueAsBuffer: false;
    }

    interface KeyAndValueAsStringIteratorOptions extends IteratorOptions {
        keyAsBuffer: false;
        valueAsBuffer: false;
    }

    interface KeyAndValueAsBufferIteratorOptions extends IteratorOptions {
        keyAsBuffer?: true;
        valueAsBuffer?: true;
    }

    interface Iterator {
        seek(key: Bytes): void;
        end(callback: ErrCallback): void;
    }

    interface KeyAsStringIterator extends Iterator {
        next(callback: KeyAsStringCallback): void;
    }

    interface ValueAsStringIterator extends Iterator {
        next(callback: ValueAsStringCallback): void;
    }

    interface KeyAndValueAsStringIterator extends Iterator {
        next(callback: KeyAndValueAsStringCallback): void;
    }

    interface KeyAndValueAsBufferIterator extends Iterator {
        next(callback: KeyAndValueAsBufferCallback): void;
    }

    interface MemDown {
        open(callback: ErrCallback): void;
        open(options: OpenOptions, callback: ErrCallback): void;
        close(callback?: ErrCallback): void;
        put(key: Bytes, value: Bytes, callback: ErrCallback): void;
        put(key: Bytes, value: Bytes, options: WriteOptions, callback: ErrCallback): void;
        get(key: Bytes, callback: ErrBufferCallback): void;
        get(key: Bytes, options: BufferReadOptions, callback: ErrBufferCallback): void;
        get(key: Bytes, options: StringReadOptions, callback: ErrStringCallback): void;
        del(key: Bytes, callback?: ErrCallback): void;
        del(key: Bytes, options: WriteOptions, callback?: ErrCallback): void;
        batch(operations: Batch[], callback?: ErrCallback): void;
        batch(operations: Batch[], options?: WriteOptions, callback?: ErrCallback): void;
        approximateSize(start: Bytes, end: Bytes, callback: ErrNumberCallback): void;
        compactRange(start: Bytes, end: Bytes, callback: ErrCallback): void;
        getProperty(property: string): string;
        iterator(options?: KeyAsStringIteratorOptions): KeyAsStringIterator;
        iterator(options?: ValueAsStringIteratorOptions): ValueAsStringIterator;
        iterator(options?: KeyAndValueAsStringIteratorOptions): KeyAndValueAsStringIterator;
        iterator(options?: KeyAndValueAsBufferIteratorOptions): KeyAndValueAsBufferIterator;
        destroy(location: string, callback: ErrCallback): void;
        repair(location: string, callback: ErrCallback): void;
    }

    type Constructor = () => MemDown;
}

const memdownConstrctor: memdown.Constructor;

export = memdownConstrctor;
}