Frodo Library - v4.5.0
    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>,
            filter?: ScriptFilter,
        ): 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[];
        importScripts(
            scriptId: string,
            scriptName: string,
            importData: ScriptExportInterface,
            options?: ScriptImportOptions,
            validate?: boolean,
            resultCallback?: ResultCallback<ScriptSkeleton>,
        ): Promise<ScriptSkeleton[]>;
        listScripts(filter?: ScriptFilter): Promise<ScriptSummary[]>;
        readScript(scriptId: string): Promise<ScriptSkeleton>;
        readScriptByName(scriptName: string): Promise<ScriptSkeleton>;
        readScripts(filter?: ScriptFilter): Promise<ScriptSkeleton[]>;
        readScriptSource(scriptId: string): Promise<string>;
        readScriptSourceByName(scriptName: string): Promise<string>;
        updateScript(
            scriptId: string,
            scriptData: ScriptSkeleton,
        ): Promise<ScriptSkeleton>;
        updateScriptSource(
            scriptId: string,
            source: string,
        ): Promise<ScriptSkeleton>;
    }
    Index

    Methods

    createScript createScriptExportTemplate deleteScript deleteScriptByName deleteScripts exportScript exportScriptByName exportScripts getLibraryScriptNames importScripts listScripts readScript readScriptByName readScripts readScriptSource readScriptSourceByName updateScript updateScriptSource

    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

    • Read a script's plain-text source only, without the surrounding metadata

      Parameters

      • scriptId: string

        script id

      Returns Promise<string>

      the decoded script source

    • Read a script's plain-text source only, by name, without the surrounding metadata

      Parameters

      • scriptName: string

        name of the script

      Returns Promise<string>

      the decoded script source

    • Update only a script's source, preserving all other metadata

      Parameters

      • scriptId: string

        script id

      • source: string

        new plain-text script source

      Returns Promise<ScriptSkeleton>

      the updated script object

    Settings

    Member Visibility

    On This Page

    Methods