@isaac-platform/isaac-integration-sdk/variables/variable.d.ts

A Typescript SDK for integrating with ISAAC

import isaacConnection from "../controller/isaac";
import { IsaacVariableType } from "./types.js";
import * as util from "util";
export declare class IsaacVariable {
    private definition;
    private isaacConn;
    constructor(definition: IsaacVariableType, connection: isaacConnection);
    setValue(value: string): Promise<IsaacVariableType>;
    /**
     * Refresh
     * Retrieves the latest copy of the variable information from ISAAC.
     * @returns IsaacVariableType
     */
    refresh(): Promise<IsaacVariableType>;
    /**
     * Get
     * @returns IsaacVariableType
     */
    get(): IsaacVariableType;
    /**
     * Disable
     * Disables the variable in the subsystem.
     * This is recommended in place of delete as it does not break any user configuration which uses the variable.
     * @returns IsaacVariableType
     */
    disable(): Promise<IsaacVariableType>;
    /**
     * Enable
     * Enables the variable in the subsystem.
     * @returns IsaacVariableType
     */
    enable(): Promise<IsaacVariableType>;
    get availableInSubsystem(): boolean;
    set availableInSubsystem(value: boolean);
    [util.inspect.custom](depth: any, opts: any): string;
}
//# sourceMappingURL=variable.d.ts.map