ScriptLoader

This class can loads dynamically scripts by using require.

Constructors

Constructor

new ScriptLoader(): ScriptLoader

Returns

ScriptLoader

Methods

loadFailsafe()

Call Signature

static loadFailsafe<TModule>(scriptName): TModule

This function will try to require a script by the given scriptName.

It will not throw an exception, it just logs a warning to the console.

const { ScriptLoader } = require("ou.sp.ScriptLoader");
const myScript = ScriptLoader.loadFailsafe("ou.cust.demo.myscript");
if (myScript) {
     myScript.sayHello();
}

Type Parameters

TModule

TModule

Parameters

scriptName

string

a script name like ou.cust.demo.myscript

Returns

TModule

Call Signature

static loadFailsafe<TModule>(scriptName, defaultModule, options?): TModule

This function will try to require a script by the given scriptName.

It will not throw an exception, it just logs a warning to the console.

with default module

const { ScriptLoader } = require("ou.sp.ScriptLoader");
const myScript = ScriptLoader.loadFailsafe("ou.cust.demo.myscript", {
     sayHello: () => util.log("Hello!")
});
myScript.sayHello();

Used with ou.spc. scripts:

// ou.spc.demo.myscript
const { ScriptLoader } = require("ou.sp.ScriptLoader");
module.exports = {
     sayHello: () => util.log("Hello!")
};

module.exports = ScriptLoader.loadFailsafe("ou.cust.demo.myscript", module.exports, { merge: true });

Type Parameters

TModule

TModule

Parameters

scriptName

string

a script name like ou.cust.demo.myscript

defaultModule

TModule

Your fallback module object

options?

LoadFailsafeOptions

Optional options

Returns

TModule