@stoqey/finnhub/dist/websocket/index.d.ts

NodeJS Finhubb wrapper

/// <reference types="node" />
import { EventEmitter } from "events";
/**
 * Finnhub websocket events
 */
export declare enum FinnhubWSEvents {
    /**
     * { symbol, date, close, volume? }
     */
    onData = "onData",
    /**
     * true / false
     */
    onReady = "onReady",
    /**
     * new Error()
     */
    onError = "onError"
}
/**
 * @Websocket
 * Stream real-time trades for US stocks, forex and crypto.
 * @see https://finnhub.io/docs/api#websocket-price
 */
export declare class FinnhubWS extends EventEmitter {
    private socket;
    private symbols;
    token: string;
    constructor(token?: string);
    /**
     * config
     */
    config(): void | NodeJS.Timeout;
    /**
     * init
     */
    private init;
    /**
     * Add symbol
     * @param symbol: string
     * @returns boolean
     */
    addSymbol(symbol: string): boolean;
    /**
     * Removes symbol from subscription list
     * @param symbol
     */
    removeSymbol(symbol: string): boolean;
}
export default FinnhubWS;