Type Alias Script

Type declaration

• createScript:function

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

    Create script

    Parameters

    • scriptId: string

      script id
    • scriptName: string

      name of the script
    • scriptData: ScriptSkeleton

      script object

    Returns Promise<ScriptSkeleton>

    a status object

• createScriptExportTemplate:function

  • createScriptExportTemplate(): ScriptExportInterface

    Create an empty script export template

    Returns ScriptExportInterface

    an empty script export template

• deleteScript:function

  • deleteScript(scriptId: string): Promise<ScriptSkeleton>

    Delete script

    Parameters

    • scriptId: string

      script id

    Returns Promise<ScriptSkeleton>

    promise that resolves to a script object

• deleteScriptByName:function

  • deleteScriptByName(scriptName: string): Promise<ScriptSkeleton>

    Delete script by name

    Parameters

    • scriptName: string

      script name

    Returns Promise<ScriptSkeleton>

    a promise that resolves to a script object

• deleteScripts:function

  • deleteScripts(): Promise<ScriptSkeleton[]>

    Delete all non-default scripts

    Returns Promise<ScriptSkeleton[]>

    a promise that resolves to an array of script objects

• exportScript:function

  • exportScript(
        scriptId: string,
        options?: ScriptExportOptions,
    ): Promise<ScriptExportInterface>

    Export script by id

    Parameters

    • scriptId: string

      script uuid
    • Optionaloptions: ScriptExportOptions

      script export options

    Returns Promise<ScriptExportInterface>

    a promise that resolved to a ScriptExportInterface object

• exportScriptByName:function

  • exportScriptByName(
        scriptName: string,
        options?: ScriptExportOptions,
    ): Promise<ScriptExportInterface>

    Export script by name

    Parameters

    • scriptName: string

      script name
    • Optionaloptions: ScriptExportOptions

      script export options

    Returns Promise<ScriptExportInterface>

    a promise that resolved to a ScriptExportInterface object

• exportScripts:function

  • exportScripts(options?: ScriptExportOptions): Promise<ScriptExportInterface>

    Export all scripts

    Parameters

    • Optionaloptions: ScriptExportOptions

      script export options

    Returns Promise<ScriptExportInterface>

    a promise that resolved to a ScriptExportInterface object

• getLibraryScriptNames:function

  • getLibraryScriptNames(scriptObj: ScriptSkeleton): string[]

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

    Parameters

    • scriptObj: ScriptSkeleton

      the script object

    Returns string[]

    an array of required library script names

• getScript:function

  • getScript(scriptId: string): Promise<ScriptSkeleton>

    Get script

    Parameters

    • scriptId: string

      script id

    Returns Promise<ScriptSkeleton>

    promise that resolves to a script object

    Deprecated

    since v2.0.0 use readScript instead

    readScript(scriptName: string): Promise<ScriptSkeleton>
    Copy

• getScriptByName:function

  • getScriptByName(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

    Deprecated

    since v2.0.0 use readScriptByName instead

    readScriptByName(scriptName: string): Promise<ScriptSkeleton>
    Copy

• getScripts:function

  • getScripts(): Promise<ScriptSkeleton[]>

    Get all scripts

    Returns Promise<ScriptSkeleton[]>

    a promise that resolves to an array of script objects

    Deprecated

    since v2.0.0 use readScripts instead

    readScripts(): Promise<ScriptSkeleton[]>
    Copy

• importScripts:function

  • importScripts(
        scriptId: string,
        scriptName: string,
        importData: ScriptExportInterface,
        options?: ScriptImportOptions,
        validate?: boolean,
    ): Promise<ScriptSkeleton[]>

    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

    Returns Promise<ScriptSkeleton[]>

    the imported scripts

• putScript:function

  • putScript(scriptId: string, scriptData: ScriptSkeleton): Promise<ScriptSkeleton>

    Create or update script

    Parameters

    • scriptId: string

      script uuid
    • scriptData: ScriptSkeleton

      script object

    Returns Promise<ScriptSkeleton>

    a status object

    Deprecated

    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>
    Copy

• readScript:function

  • readScript(scriptId: string): Promise<ScriptSkeleton>

    Read script

    Parameters

    • scriptId: string

      script id

    Returns Promise<ScriptSkeleton>

    promise that resolves to a script object

• readScriptByName:function

  • readScriptByName(scriptName: string): Promise<ScriptSkeleton>

    Read script by name

    Parameters

    • scriptName: string

      name of the script

    Returns Promise<ScriptSkeleton>

    promise that resolves to a script object

• readScripts:function

  • readScripts(): Promise<ScriptSkeleton[]>

    Read all scripts

    Returns Promise<ScriptSkeleton[]>

    a promise that resolves to an array of script objects

• updateScript:function

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

    Create or update script

    Parameters

    • scriptId: string

      script id
    • scriptData: ScriptSkeleton

      script object

    Returns Promise<ScriptSkeleton>

    a status object