Initial commit - Event Planner application

node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts

@@ -0,0 +1,88 @@
+export type ContextType = 'http' | 'ws' | 'rpc';
+/**
+ * Methods to obtain request and response objects.
+ *
+ * @publicApi
+ */
+export interface HttpArgumentsHost {
+    /**
+     * Returns the in-flight `request` object.
+     */
+    getRequest<T = any>(): T;
+    /**
+     * Returns the in-flight `response` object.
+     */
+    getResponse<T = any>(): T;
+    getNext<T = any>(): T;
+}
+/**
+ * Methods to obtain WebSocket data and client objects.
+ *
+ * @publicApi
+ */
+export interface WsArgumentsHost {
+    /**
+     * Returns the data object.
+     */
+    getData<T = any>(): T;
+    /**
+     * Returns the client object.
+     */
+    getClient<T = any>(): T;
+    /**
+     * Returns the pattern for the event
+     */
+    getPattern(): string;
+}
+/**
+ * Methods to obtain RPC data object.
+ *
+ * @publicApi
+ */
+export interface RpcArgumentsHost {
+    /**
+     * Returns the data object.
+     */
+    getData<T = any>(): T;
+    /**
+     * Returns the context object.
+     */
+    getContext<T = any>(): T;
+}
+/**
+ * Provides methods for retrieving the arguments being passed to a handler.
+ * Allows choosing the appropriate execution context (e.g., Http, RPC, or
+ * WebSockets) to retrieve the arguments from.
+ *
+ * @publicApi
+ */
+export interface ArgumentsHost {
+    /**
+     * Returns the array of arguments being passed to the handler.
+     */
+    getArgs<T extends Array<any> = any[]>(): T;
+    /**
+     * Returns a particular argument by index.
+     * @param index index of argument to retrieve
+     */
+    getArgByIndex<T = any>(index: number): T;
+    /**
+     * Switch context to RPC.
+     * @returns interface with methods to retrieve RPC arguments
+     */
+    switchToRpc(): RpcArgumentsHost;
+    /**
+     * Switch context to HTTP.
+     * @returns interface with methods to retrieve HTTP arguments
+     */
+    switchToHttp(): HttpArgumentsHost;
+    /**
+     * Switch context to WebSockets.
+     * @returns interface with methods to retrieve WebSockets arguments
+     */
+    switchToWs(): WsArgumentsHost;
+    /**
+     * Returns the current execution context type (string)
+     */
+    getType<TContext extends string = ContextType>(): TContext;
+}