@loopeco/socketio/dist/middleware.d.ts

A enhanced LoopBack's WebSocket server based on socket.io

import { BindingTemplate, Constructor, Context, Provider } from '@loopback/core';
import { InvokeMiddlewareOptions, Middleware, MiddlewareBindingOptions } from '@loopback/express';
import { SocketIoConnectionHandler } from './types';
/**
 * Template function for middleware bindings
 * @param options - Options to configure the binding
 */
export declare function asMiddlewareForSocketIo(options?: MiddlewareBindingOptions): BindingTemplate;
/**
 * Bind the middleware function or provider class to the context
 * @param ctx - Context object
 * @param middleware - Middleware function or provider class
 * @param options - Middleware binding options
 */
export declare function registerMiddlewareForSocketIo(ctx: Context, middleware: Middleware | Constructor<Provider<Middleware>>, options: MiddlewareBindingOptions): import("@loopback/core").Binding<Middleware>;
/**
 * Create a binding for the middleware provider class
 *
 * @param middlewareProviderClass - Middleware provider class
 * @param options - Options to create middleware binding
 *
 */
export declare function createMiddlewareBindingForSocketIo(middlewareProviderClass: Constructor<Provider<Middleware>>, options?: MiddlewareBindingOptions): import("@loopback/core").Binding<Middleware>;
/**
 * An adapter function to create an SocketIo middleware handler to discover and
 * invoke registered LoopBack-style middleware in the context.
 * @param ctx - Context object to discover registered middleware
 * @param options - Options for middleware invoking
 */
export declare function toSocketIoMiddleware(ctx: Context, options?: InvokeMiddlewareOptions): SocketIoConnectionHandler;