@elgato/streamdeck/types/plugin/ui/route.d.ts

The official Node.js SDK for creating Stream Deck plugins.

import type { JsonObject, JsonValue } from "../../common/json";
import { type MessageResponder } from "../../common/messaging";
import type { SingletonAction } from "../actions/singleton-action";
import type { MessageHandler, MessageRequest } from "./message";
/**
 * Registers the function as a route, exposing it to the property inspector via `streamDeck.plugin.fetch(path)`.
 * @param path Path that identifies the route.
 * @returns The decorator factory.
 */
export declare function route<TBody extends JsonValue = JsonValue, TSettings extends JsonObject = JsonObject, TResult extends ReturnType<MessageHandler<TBody, TSettings>> = undefined>(path: string): (target: MessageHandler<TBody, TSettings>, context: ClassMethodDecoratorContext<SingletonAction>) => OptionalParameterMessageHandler<TBody, TSettings, TResult> | void;
/**
 * Wraps {@link MessageHandler} to provide scoped request, with a dynamic return type.
 * @param request Request received from the property inspector.
 * @param responder Responder responsible for responding to the request.
 * @template TBody The type of the request body.
 * @template TSettings The type of the action's settings.
 * @template TResult The type of the result of the request handler.
 */
type OptionalParameterMessageHandler<TBody extends JsonValue, TSettings extends JsonObject, TResult> = (request?: MessageRequest<TBody, TSettings>, responder?: MessageResponder) => TResult;
export {};