3.0.7 • Published 6 months ago
@types/stream-buffers v3.0.7
Installation
npm install --save @types/stream-buffers
Summary
This package contains type definitions for stream-buffers (https://github.com/samcday/node-stream-buffer#readme).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stream-buffers.
index.d.ts
// 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 | undefined;
incrementAmount?: number | undefined;
}
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 | undefined;
chunkSize?: number | undefined;
initialSize?: number | undefined;
incrementAmount?: number | undefined;
}
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;
Additional Details
- Last updated: Fri, 02 Jul 2021 22:32:58 GMT
- Dependencies: @types/node
- Global values: none
Credits
These definitions were written by Jason Dent.