@push.rocks/smartsocket/dist_ts/smartsocket.classes.socketfunction.d.ts

Provides easy and secure websocket communication mechanisms, including server and client implementation, function call routing, connection management, and tagging.

import * as plugins from './smartsocket.plugins.js';
import { SocketConnection } from './smartsocket.classes.socketconnection.js';
import { Smartsocket } from './smartsocket.classes.smartsocket.js';
import { SmartsocketClient } from './smartsocket.classes.smartsocketclient.js';
/**
 * interface of the contructor options of class SocketFunction
 */
export interface ISocketFunctionConstructorOptions<T extends plugins.typedrequestInterfaces.ITypedRequest> {
    funcName: T['method'];
    funcDef: TFuncDef<T>;
}
/**
 * interface of the Socket Function call, in other words the object that routes a call to a function
 */
export interface ISocketFunctionCallDataRequest<T extends plugins.typedrequestInterfaces.ITypedRequest> {
    funcName: T['method'];
    funcDataArg: T['request'];
}
/**
 * interface of the Socket Function call, in other words the object that routes a call to a function
 */
export interface ISocketFunctionCallDataResponse<T extends plugins.typedrequestInterfaces.ITypedRequest> {
    funcName: T['method'];
    funcDataArg: T['response'];
}
/**
 * interface for function definition of SocketFunction
 */
export type TFuncDef<T extends plugins.typedrequestInterfaces.ITypedRequest> = (dataArg: T['request'], connectionArg: SocketConnection) => PromiseLike<T['response']>;
/**
 * class that respresents a function that can be transparently called using a SocketConnection
 */
export declare class SocketFunction<T extends plugins.typedrequestInterfaces.ITypedRequest> {
    static getSocketFunctionByName<Q extends plugins.typedrequestInterfaces.ITypedRequest>(smartsocketRefArg: Smartsocket | SmartsocketClient, functionNameArg: string): SocketFunction<Q>;
    name: string;
    funcDef: TFuncDef<T>;
    /**
     * the constructor for SocketFunction
     */
    constructor(optionsArg: ISocketFunctionConstructorOptions<T>);
    /**
     * invokes the function of this SocketFunction
     */
    invoke(dataArg: ISocketFunctionCallDataRequest<T>, socketConnectionArg: SocketConnection): Promise<ISocketFunctionCallDataResponse<T>>;
}