node: NodeBuffer -> Buffer. Mark NodeBuffer as deprecated

This commit is contained in:
Paul Loyd
2014-04-28 18:32:36 +02:00
committed by Bart van der Schoor
parent bcd40a14f0
commit 1d451a05e1
14 changed files with 251 additions and 246 deletions
+20 -20
View File
@@ -128,11 +128,11 @@ declare module "websocket" {
constructor(serverConfig?: IServerConfig);
/** Send binary message for each connection */
broadcast(data: NodeBuffer): void;
broadcast(data: Buffer): void;
/** Send UTF-8 message for each connection */
broadcast(data: IStringified): void;
/** Send binary message for each connection */
broadcastBytes(data: NodeBuffer): void;
broadcastBytes(data: Buffer): void;
/** Send UTF-8 message for each connection */
broadcastUTF(data: IStringified): void;
/** Attach the `server` instance to a Node http.Server instance */
@@ -251,26 +251,26 @@ declare module "websocket" {
export interface IMessage {
type: string;
utf8Data?: string;
binaryData?: NodeBuffer;
binaryData?: Buffer;
}
export interface IBufferList extends events.EventEmitter {
encoding: string;
length: number;
write(buf: NodeBuffer): boolean;
end(buf: NodeBuffer): void;
write(buf: Buffer): boolean;
end(buf: Buffer): void;
/**
* For each buffer, perform some action.
* If fn's result is a true value, cut out early.
*/
forEach(fn: (buf: NodeBuffer) => boolean): void;
forEach(fn: (buf: Buffer) => boolean): void;
/** Create a single buffer out of all the chunks */
join(start: number, end: number): NodeBuffer;
join(start: number, end: number): Buffer;
/** Join all the chunks to existing buffer */
joinInto(buf: NodeBuffer, offset: number, start: number, end: number): NodeBuffer;
joinInto(buf: Buffer, offset: number, start: number, end: number): Buffer;
/**
* Advance the buffer stream by `n` bytes.
@@ -290,10 +290,10 @@ declare module "websocket" {
// Events
on(event: string, listener: () => void): IBufferList;
on(event: 'advance', cb: (n: number) => void): IBufferList;
on(event: 'write', cb: (buf: NodeBuffer) => void): IBufferList;
on(event: 'write', cb: (buf: Buffer) => void): IBufferList;
addListener(event: string, listener: () => void): IBufferList;
addListener(event: 'advance', cb: (n: number) => void): IBufferList;
addListener(event: 'write', cb: (buf: NodeBuffer) => void): IBufferList;
addListener(event: 'write', cb: (buf: Buffer) => void): IBufferList;
}
class connection extends events.EventEmitter {
@@ -330,8 +330,8 @@ declare module "websocket" {
config: IConfig;
socket: net.Socket;
maskOutgoingPackets: boolean;
maskBytes: NodeBuffer;
frameHeader: NodeBuffer;
maskBytes: Buffer;
frameHeader: Buffer;
bufferList: IBufferList;
currentFrame: frame;
fragmentationSize: number;
@@ -390,14 +390,14 @@ declare module "websocket" {
* to the remote peer. If config.fragmentOutgoingMessages is true the message may be
* sent as multiple fragments if it exceeds config.fragmentationThreshold bytes.
*/
sendBytes(buffer: NodeBuffer): void;
sendBytes(buffer: Buffer): void;
/** Auto-detect the data type and send UTF-8 or Binary message */
send(data: NodeBuffer): void;
send(data: Buffer): void;
send(data: IStringified): void;
/** Sends a ping frame. Ping frames must not exceed 125 bytes in length. */
ping(data: NodeBuffer): void;
ping(data: Buffer): void;
ping(data: IStringified): void;
/**
@@ -408,7 +408,7 @@ declare module "websocket" {
* be no need to use this method to respond to pings.
* Pong frames must not exceed 125 bytes in length.
*/
pong(buffer: NodeBuffer): void;
pong(buffer: Buffer): void;
/**
* Serializes a `frame` object into binary data and immediately sends it to
@@ -494,10 +494,10 @@ declare module "websocket" {
* The binary payload data.
* Even text frames are sent with a Buffer providing the binary payload data.
*/
binaryPayload: NodeBuffer;
binaryPayload: Buffer;
maskBytes: NodeBuffer;
frameHeader: NodeBuffer;
maskBytes: Buffer;
frameHeader: Buffer;
config: IConfig;
maxReceivedFrameSize: number;
protocolError: boolean;
@@ -507,7 +507,7 @@ declare module "websocket" {
addData(bufferList: IBufferList): boolean;
throwAwayPayload(bufferList: IBufferList): boolean;
toBuffer(nullMask: boolean): NodeBuffer;
toBuffer(nullMask: boolean): Buffer;
}
export interface IClientConfig extends IConfig {