a2r/model/socket.d.ts

A2R Framework

import { Socket } from 'socket.io';
/**
 * Socket method call
 */
export interface MethodCall {
    /**
     * Unique ID for socket transmission
     * @type {string}
     * @memberof MethodCall
     */
    id: string;
    /**
     * Params for API Method
     * @memberof MethodCall
     */
    params: any[];
}
/**
 * Socket standard response
 */
export interface SocketMessage {
    /**
     * Operation was ok (0) or not (1)
     * @memberof SocketMessage
     */
    o: number;
    /**
     * Operation error (if any)
     * @memberof SocketMessage
     */
    e?: string;
    /**
     * Operation stack (if error)
     * @memberof SocketMessage
     */
    s?: string;
    /**
     * Operation return data
     * @memberof SocketMessage
     */
    d: any;
}
/**
 * A2R Socket
 */
export interface A2RSocket extends Socket {
    sessionId: string;
    userToken?: string;
    ips: string[];
    referer: string;
}