mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
[minipass] add typings
This commit is contained in:
parent
c5d04fb2d5
commit
b7a2c94313
68
types/minipass/index.d.ts
vendored
Normal file
68
types/minipass/index.d.ts
vendored
Normal file
@ -0,0 +1,68 @@
|
||||
// Type definitions for minipass 2.2
|
||||
// Project: https://github.com/isaacs/minipass#readme
|
||||
// Definitions by: BendingBender <https://github.com/BendingBender>
|
||||
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
||||
|
||||
/// <reference types="node" />
|
||||
import { EventEmitter } from 'events';
|
||||
|
||||
export = MiniPass;
|
||||
|
||||
declare class MiniPass extends EventEmitter implements NodeJS.WritableStream {
|
||||
readonly bufferLength: number;
|
||||
readonly flowing: boolean;
|
||||
readonly emittedEnd: boolean;
|
||||
encoding: string | null;
|
||||
readable: boolean;
|
||||
writable: boolean;
|
||||
pipes: any;
|
||||
buffer: any;
|
||||
|
||||
constructor(options?: MiniPass.Options);
|
||||
|
||||
setEncoding(encoding: string | null): void;
|
||||
read(size?: number): any;
|
||||
write(chunk: any, cb?: () => void): boolean;
|
||||
write(chunk: any, encoding?: string | null, cb?: () => void): boolean;
|
||||
end(cb?: () => void): void;
|
||||
end(chunk: any, cb?: () => void): void;
|
||||
end(chunk: any, encoding?: string | null, cb?: () => void): void;
|
||||
resume(): void;
|
||||
pause(): void;
|
||||
pipe<T extends NodeJS.WritableStream>(destination: T, options?: { end?: boolean; }): T;
|
||||
|
||||
addEventHandler(event: string, listener: (...args: any[]) => void): this;
|
||||
addEventHandler(event: 'data', listener: (chunk: any) => void): this;
|
||||
addEventHandler(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
on(event: string, listener: (...args: any[]) => void): this;
|
||||
on(event: 'data', listener: (chunk: any) => void): this;
|
||||
on(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
once(event: string, listener: (...args: any[]) => void): this;
|
||||
once(event: 'data', listener: (chunk: any) => void): this;
|
||||
once(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
prependListener(event: string, listener: (...args: any[]) => void): this;
|
||||
prependListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
prependListener(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
prependOnceListener(event: string, listener: (...args: any[]) => void): this;
|
||||
prependOnceListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
prependOnceListener(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
removeListener(event: string, listener: (...args: any[]) => void): this;
|
||||
removeListener(event: 'data', listener: (chunk: any) => void): this;
|
||||
removeListener(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close', listener: () => void): this;
|
||||
|
||||
emit(event: string, ...args: any[]): boolean;
|
||||
emit(event: 'data', chunk: any): boolean;
|
||||
emit(event: 'readable' | 'drain' | 'resume' | 'end' | 'prefinish' | 'finish' | 'close'): boolean;
|
||||
}
|
||||
|
||||
declare namespace MiniPass {
|
||||
interface Options {
|
||||
objectMode?: boolean;
|
||||
encoding?: string | null;
|
||||
}
|
||||
}
|
||||
52
types/minipass/minipass-tests.ts
Normal file
52
types/minipass/minipass-tests.ts
Normal file
@ -0,0 +1,52 @@
|
||||
import MiniPass = require('minipass');
|
||||
|
||||
let encoding: string | null = null;
|
||||
|
||||
new MiniPass();
|
||||
new MiniPass({objectMode: true});
|
||||
const mp = new MiniPass({encoding: 'utf8'});
|
||||
|
||||
mp.flowing; // $ExpectType boolean
|
||||
mp.flowing = true; // $ExpectError
|
||||
mp.bufferLength; // $ExpectType number
|
||||
mp.bufferLength = 1; // $ExpectError
|
||||
mp.emittedEnd; // $ExpectType boolean
|
||||
mp.emittedEnd = true; // $ExpectError
|
||||
mp.encoding = encoding;
|
||||
mp.readable; // $ExpectType boolean
|
||||
mp.writable; // $ExpectType boolean
|
||||
mp.buffer; // $ExpectType any
|
||||
mp.pipes; // $ExpectType any
|
||||
|
||||
mp.setEncoding(encoding);
|
||||
mp.read(); // $ExpectType any
|
||||
mp.read(1);
|
||||
mp.write('foo'); // $ExpectType boolean
|
||||
mp.write('foo', () => {});
|
||||
mp.write('foo', encoding);
|
||||
mp.write('foo', encoding, () => {});
|
||||
mp.end();
|
||||
mp.end(() => {});
|
||||
mp.end('bar');
|
||||
mp.end(new Buffer('bar'));
|
||||
mp.end('bar', () => {});
|
||||
mp.end(new Buffer('bar'), () => {});
|
||||
mp.end('bar', encoding);
|
||||
mp.end('bar', encoding, () => {});
|
||||
mp.resume();
|
||||
mp.pause();
|
||||
mp.pipe(process.stdout); // $ExpectType WriteStream
|
||||
|
||||
mp.on('data', chunk => {
|
||||
chunk; // $ExpectType any
|
||||
});
|
||||
mp.on('readable', () => {});
|
||||
mp.on('drain', () => {});
|
||||
mp.on('resume', () => {});
|
||||
mp.on('end', () => {});
|
||||
mp.on('prefinish', () => {});
|
||||
mp.on('finish', () => {});
|
||||
mp.on('close', () => {});
|
||||
mp.on('foo', (a, b, c) => {});
|
||||
|
||||
process.stdin.pipe(mp).pipe(process.stdout);
|
||||
22
types/minipass/tsconfig.json
Normal file
22
types/minipass/tsconfig.json
Normal file
@ -0,0 +1,22 @@
|
||||
{
|
||||
"compilerOptions": {
|
||||
"module": "commonjs",
|
||||
"lib": [
|
||||
"es6"
|
||||
],
|
||||
"noImplicitAny": true,
|
||||
"noImplicitThis": true,
|
||||
"strictNullChecks": true,
|
||||
"baseUrl": "../",
|
||||
"typeRoots": [
|
||||
"../"
|
||||
],
|
||||
"types": [],
|
||||
"noEmit": true,
|
||||
"forceConsistentCasingInFileNames": true
|
||||
},
|
||||
"files": [
|
||||
"index.d.ts",
|
||||
"minipass-tests.ts"
|
||||
]
|
||||
}
|
||||
1
types/minipass/tslint.json
Normal file
1
types/minipass/tslint.json
Normal file
@ -0,0 +1 @@
|
||||
{ "extends": "dtslint/dt.json" }
|
||||
Loading…
Reference in New Issue
Block a user