@crowbartools/firebot-types 5.67.0-alpha6 → 5.67.0-alpha7

package/backend/custom-scripts/script-api/namespaces/parameters.d.ts

@@ -0,0 +1,2 @@
+import type { ScriptParametersApi } from "../../../../types/script-api";
+export declare const createParametersApi: import("../internal/define-namespace").ScriptApiNamespaceFactory<ScriptParametersApi>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crowbartools/firebot-types",
-  "version": "5.67.0-alpha6",
+  "version": "5.67.0-alpha7",
   "description": "Type definitions and script API for Firebot plugins and custom scripts.",
   "main": "index.js",
   "types": "index.d.ts",

package/types/script-api.d.ts

@@ -121,6 +121,14 @@ export interface ScriptTwitchApi {
     api: typeof TwitchApi;
 }
 
+/**
+ * Access to this plugin's saved parameter values (the settings configured by
+ * the user)
+ */
+export interface ScriptParametersApi {
+    getAll<T extends Record<string, unknown> = Record<string, unknown>>(): T;
+}
+
 export interface ScriptFrontendCommunicatorApi {
     /** Send a synchronous event to the frontend. */
     send<ExpectedArg = unknown>(eventName: string, data?: ExpectedArg): void;
@@ -168,6 +176,8 @@ export interface FirebotScriptApi {
     effects: ScriptEffectsApi;
     /** Access to Firebot's Twitch API wrappers (Helix, chat, auth, etc). */
     twitch: ScriptTwitchApi;
+    /** This plugin's saved parameter values. */
+    parameters: ScriptParametersApi;
     /** Two-way messaging between the script and the frontend. */
     frontendCommunicator: ScriptFrontendCommunicatorApi;
 }