/// <reference path="./sigApi.ApiBase.d.ts" />

declare namespace SigApi {
    interface ApiWebsocketState extends ApiBase {
        /**
         * websocketState api subscribes on WS_STATE_CHG
         * 
         * in scenarios where the consumer of this api does subscribe on WS_STATE_CHG order of execution of listeners can not be guarantied;
         * 
         * the use of this.websocketState.getState() is recommended for getting the initial value
         * @returns {number} STAT_WS_* defined in SIG_CONST
         */
        getState(): number
    }
}
