DefinitelyTyped/types/stream-buffers/index.d.ts
KARASZI István 3d1a0834a9 [@types/stream-buffers]: Add false to the return values (#34885)
* Add false to the return values

The source code returns false when the size is zero

* Add and update tests
2019-04-24 15:15:05 -05:00

41 lines
1.3 KiB
TypeScript

// Type definitions for stream-buffers 3.0
// Project: https://github.com/samcday/node-stream-buffer#readme
// Definitions by: Jason Dent <https://github.com/Jason3S>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
/// <reference types="node" />
import * as stream from 'stream';
export interface WritableStreamBufferOptions extends stream.WritableOptions {
initialSize?: number;
incrementAmount?: number;
}
export class WritableStreamBuffer extends stream.Writable {
constructor(options?: WritableStreamBufferOptions);
size(): number;
maxSize(): number;
getContents(length?: number): Buffer | false;
getContentsAsString(encoding?: string, length?: number): string | false;
}
export interface ReadableStreamBufferOptions extends stream.ReadableOptions {
frequency?: number;
chunkSize?: number;
initialSize?: number;
incrementAmount?: number;
}
export class ReadableStreamBuffer extends stream.Readable {
constructor(options?: ReadableStreamBufferOptions);
put(data: string | Buffer, encoding?: string): void;
stop(): void;
size(): number;
maxSize(): number;
}
export const DEFAULT_INITIAL_SIZE: number;
export const DEFAULT_INCREMENT_AMOUNT: number;
export const DEFAULT_FREQUENCY: number;
export const DEFAULT_CHUNK_SIZE: number;