tlab-trading-toolkit/declarations/src/lib/AbstractMessageTransform.d.ts

A trading toolkit for building advanced trading bots on the GDAX platform

/// <reference types="node" />
/***************************************************************************************************************************
 * @license                                                                                                                *
 * Copyright 2017 Coinbase, Inc.                                                                                           *
 *                                                                                                                         *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance          *
 * with the License. You may obtain a copy of the License at                                                               *
 *                                                                                                                         *
 * http://www.apache.org/licenses/LICENSE-2.0                                                                              *
 *                                                                                                                         *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on     *
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the                      *
 * License for the specific language governing permissions and limitations under the License.                              *
 ***************************************************************************************************************************/
import stream = require('stream');
import { StreamMessage } from '../core/Messages';
import { Logger } from '../utils/Logger';
export interface MessageTransformConfig {
    logger?: Logger;
}
/**
 * A base class for providing message transform streams and filters. All this class does is implement some common logic,
 * making sure that the streamed messages are GDAXMessages before calling the `transformMessage` method that subclasses
 * will implement.
 */
export declare abstract class AbstractMessageTransform extends stream.Transform {
    protected logger: Logger;
    constructor(config: MessageTransformConfig);
    log(level: string, message: string, meta?: any): void;
    read(size?: number): StreamMessage;
    _transform(chunk: any, encoding: string, callback: (err: Error, chunk?: any) => void): void;
    abstract transformMessage(msg: StreamMessage): StreamMessage;
}