mirror of
https://github.com/FlipsideCrypto/DefinitelyTyped.git
synced 2026-02-06 10:56:53 +00:00
added definitions for bufferstream
This commit is contained in:
parent
6745ac3279
commit
3c1c84fb4c
14
bufferstream/bufferstream-tests.ts
Normal file
14
bufferstream/bufferstream-tests.ts
Normal file
@ -0,0 +1,14 @@
|
||||
/// <reference path="bufferstream.d.ts" />
|
||||
|
||||
import BufferStream = require('bufferstream')
|
||||
|
||||
var stream = new BufferStream({encoding:'utf8', size:'flexible'});
|
||||
stream.enable();
|
||||
stream.disable();
|
||||
stream.split('//', ':');
|
||||
stream.on('split', (chunk: any, token: any) => {
|
||||
console.log("got '%s' by '%s'", chunk.toString(), token.toString())
|
||||
});
|
||||
stream.write("buffer:stream//23");
|
||||
console.log(stream.toString());
|
||||
|
||||
119
bufferstream/bufferstream.d.ts
vendored
Normal file
119
bufferstream/bufferstream.d.ts
vendored
Normal file
@ -0,0 +1,119 @@
|
||||
// Type definitions for bufferstream v0.6.2
|
||||
// Project: https://github.com/dodo/node-bufferstream
|
||||
// Definitions by: Bart van der Schoor <https://github.com/Bartvds>
|
||||
// Definitions: https://github.com/borisyankov/DefinitelyTyped
|
||||
|
||||
/// <reference path="../node/node.d.ts" />
|
||||
|
||||
declare module 'bufferstream' {
|
||||
import stream = require('stream');
|
||||
|
||||
export = BufferStream;
|
||||
|
||||
class BufferStream extends stream.Duplex {
|
||||
constructor(options?: BufferStream.Opts);
|
||||
|
||||
/*
|
||||
different buffer behaviors can be triggered by size:
|
||||
|
||||
none when output drains, bufferstream drains too
|
||||
flexible buffers everthing that it gets and not piping out
|
||||
<number> TODO buffer has given size. buffers everthing until buffer is full. when buffer is full then the stream will drain
|
||||
*/
|
||||
setSize(size: string): void; // can be one of ['none', 'flexible', <number>]
|
||||
setSize(size: number): void; // can be one of ['none', 'flexible', <number>]
|
||||
/*
|
||||
enables stream buffering default
|
||||
*/
|
||||
enable(): void;
|
||||
/*
|
||||
flushes buffer and disables stream buffering. BufferStream now pipes all data as long as the output accepting data. when the output is draining BufferStream will buffer all input temporary.
|
||||
|
||||
token[s] buffer splitters (should be String or Buffer)
|
||||
|
||||
disables given tokens. wont flush until no splitter tokens are left.
|
||||
*/
|
||||
disable(): void;
|
||||
disable(token: string, ...tokens: string[]): void;
|
||||
disable(tokens: string[]): void; // Array
|
||||
disable(token: Buffer, ...tokens: Buffer[]): void;
|
||||
disable(tokens: Buffer[]): void; // Array
|
||||
/*
|
||||
each time BufferStream finds a splitter token in the input data it will emit a split event. this also works for binary data.
|
||||
|
||||
token[s] buffer splitters (should be String or Buffer)
|
||||
*/
|
||||
split(token: string, ...tokens: string[]): void;
|
||||
split(tokens: string[]): void; // Array
|
||||
split(token: Buffer, ...tokens: Buffer[]): void;
|
||||
split(tokens: Buffer[]): void; // Array
|
||||
/*
|
||||
returns Buffer.
|
||||
*/
|
||||
getBuffer(): Buffer;
|
||||
/*
|
||||
returns Buffer.
|
||||
*/
|
||||
buffer: Buffer;
|
||||
/*
|
||||
shortcut for buffer.toString()
|
||||
*/
|
||||
toString(): string;
|
||||
/*
|
||||
shortcut for buffer.length
|
||||
*/
|
||||
length: number;
|
||||
}
|
||||
module BufferStream {
|
||||
|
||||
export interface Opts {
|
||||
/*
|
||||
default encoding for writing strings
|
||||
*/
|
||||
encoding?: string;
|
||||
/*
|
||||
if true and the source is a child_process the stream will block the entire process (timeouts wont work anymore, but splitting and listening on data still works, because they work sync)
|
||||
*/
|
||||
blocking?: boolean;
|
||||
/*
|
||||
defines buffer level or sets buffer to given size (see ↓setSize for more)
|
||||
*/
|
||||
size?: any;
|
||||
/*
|
||||
immediately call disable
|
||||
*/
|
||||
disabled?: boolean;
|
||||
/*
|
||||
short form for:
|
||||
split(token, function (chunk) {emit('data', chunk)})
|
||||
*/
|
||||
// String or Buffer
|
||||
split?: any;
|
||||
}
|
||||
export var fn: {warn: boolean};
|
||||
}
|
||||
}
|
||||
|
||||
declare module 'bufferstream/postbuffer' {
|
||||
import http = require('http');
|
||||
import BufferStream = require('bufferstream');
|
||||
|
||||
class PostBuffer extends BufferStream {
|
||||
/*
|
||||
for if you want to get all the post data from a http server request and do some db reqeust before.
|
||||
|
||||
http client buffer
|
||||
*/
|
||||
constructor(req: http.ServerRequest);
|
||||
/*
|
||||
set a callback to get all post data from a http server request
|
||||
*/
|
||||
onEnd(callback: (data: any) => void): void;
|
||||
/*
|
||||
pumps data into another stream to allow incoming streams given options will be passed to Stream.pipe
|
||||
*/
|
||||
pipe(stream: NodeJS.WritableStream, options?: BufferStream.Opts): NodeJS.ReadableStream;
|
||||
}
|
||||
|
||||
export = PostBuffer;
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user