Frodo Library - v4.0.0-10
    Preparing search index...

    Type Alias Script

    type Script = {
        createScript(
            scriptId: string,
            scriptName: string,
            scriptData: ScriptSkeleton,
        ): Promise<ScriptSkeleton>;
        createScriptExportTemplate(): ScriptExportInterface;
        deleteScript(scriptId: string): Promise<ScriptSkeleton>;
        deleteScriptByName(scriptName: string): Promise<ScriptSkeleton>;
        deleteScripts(
            resultCallback?: ResultCallback<ScriptSkeleton>,
        ): Promise<ScriptSkeleton[]>;
        exportScript(
            scriptId: string,
            options?: ScriptExportOptions,
        ): Promise<ScriptExportInterface>;
        exportScriptByName(
            scriptName: string,
            options?: ScriptExportOptions,
        ): Promise<ScriptExportInterface>;
        exportScripts(
            options?: ScriptExportOptions,
            resultCallback?: ResultCallback<ScriptSkeleton>,
        ): Promise<ScriptExportInterface>;
        getLibraryScriptNames(scriptObj: ScriptSkeleton): string[];
        getScript(scriptId: string): Promise<ScriptSkeleton>;
        getScriptByName(scriptName: string): Promise<ScriptSkeleton>;
        getScripts(): Promise<ScriptSkeleton[]>;
        importScripts(
            scriptId: string,
            scriptName: string,
            importData: ScriptExportInterface,
            options?: ScriptImportOptions,
            validate?: boolean,
            resultCallback?: ResultCallback<ScriptSkeleton>,
        ): Promise<ScriptSkeleton[]>;
        putScript(
            scriptId: string,
            scriptData: ScriptSkeleton,
        ): Promise<ScriptSkeleton>;
        readScript(scriptId: string): Promise<ScriptSkeleton>;
        readScriptByName(scriptName: string): Promise<ScriptSkeleton>;
        readScripts(): Promise<ScriptSkeleton[]>;
        updateScript(
            scriptId: string,
            scriptData: ScriptSkeleton,
        ): Promise<ScriptSkeleton>;
    }
    Index

    Methods

    createScript createScriptExportTemplate deleteScript deleteScriptByName deleteScripts exportScript exportScriptByName exportScripts getLibraryScriptNames importScripts readScript readScriptByName readScripts updateScript

    Deprecated

    getScript getScriptByName getScripts putScript

    Methods

    • Get the names of library scripts required by the input script object

      Parameters

      Returns string[]

      an array of required library script names

    • Import scripts

      Parameters

      • scriptId: string

        Optional id of script. If supplied, only the script of that id is imported. Takes priority over scriptName if both are provided.

      • scriptName: string

        Optional name of script. If supplied, only the script of that name is imported

      • importData: ScriptExportInterface

        Script import data

      • Optionaloptions: ScriptImportOptions

        Script import options

      • Optionalvalidate: boolean

        If true, validates Javascript scripts to ensure no errors exist in them. Default: false

      • OptionalresultCallback: ResultCallback<ScriptSkeleton>

        Optional callback to process individual results

      Returns Promise<ScriptSkeleton[]>

      the imported scripts

    Deprecated

    • Get script

      Parameters

      • scriptId: string

        script id

      Returns Promise<ScriptSkeleton>

      promise that resolves to a script object

      since v2.0.0 use readScript instead

      readScript(scriptName: string): Promise<ScriptSkeleton>

    • Get script by name

      Parameters

      • scriptName: string

        name of the script

      Returns Promise<ScriptSkeleton>

      promise that resolves to a script object

      since v2.0.0 use readScriptByName instead

      readScriptByName(scriptName: string): Promise<ScriptSkeleton>

    • Create or update script

      Parameters

      Returns Promise<ScriptSkeleton>

      a status object

      since v2.0.0 use updateScript or createScript instead

      updateScript(scriptId: string, scriptData: ScriptSkeleton): Promise<ScriptSkeleton>
      createScript(scriptId: string, scriptName: string, scriptData: ScriptSkeleton): Promise<ScriptSkeleton>

    Settings

    Member Visibility

    On This Page

    Methods
    Deprecated