Class: Script

Class: Script#

Defines a script that can be loaded into a service at runtime and perform one of the following behaviors:

  • Background Job

  • Data Model

  • Event Processor

  • Route Handler

author Jean-Philippe Steinmetz

Hierarchy#

Index#

Constructors#

Properties#

Accessors#

Constructors#

constructor#

+ new Script(other?: any): Script

Overrides EntityBase.constructor

Defined in src/models/Script.ts:74

Parameters:#

Name

Type

other?

any

Returns: Script

Properties#

checksum#

• checksum: string = “”

Defined in src/models/Script.ts:47

The hashed sum of the contents of the script data.

comments#

• comments: string = “”

Defined in src/models/Script.ts:50

The textual comments associated with this script version.

data#

• data: Buffer | string = “”

Defined in src/models/Script.ts:53

The script data as a Buffer or a base64 encoded string.

dateCreated#

• dateCreated: Date = new Date()

Inherited from EntityBase.dateCreated

Defined in src/EntityBase.ts:18

The date and time that the object was created.

dateModified#

• dateModified: Date = new Date()

Inherited from EntityBase.dateModified

Defined in src/EntityBase.ts:23

The date and time that the object was last modified.

deleted#

• deleted: boolean = false

Defined in src/models/Script.ts:56

Indicates if the script has been deleted and should no longer be included.

filename#

• filename: string = “”

Defined in src/models/Script.ts:59

The name of the script file on disk.

language#

• language: ScriptLanguage = ScriptLanguage.JAVASCRIPT

Defined in src/models/Script.ts:62

The programming language of the script.

name#

• name: string = “”

Defined in src/models/Script.ts:65

The unique name of the script.

published#

• published: boolean = false

Defined in src/models/Script.ts:68

Indicates if the script is active for inclusion in the service runtime.

source#

• source: ScriptSource = ScriptSource.USER

Defined in src/models/Script.ts:71

The original source of the document.

type#

• type: ScriptType = ScriptType.OTHER

Defined in src/models/Script.ts:74

The script’s function type describing how it should be loaded into the service.

uid#

• uid: string = uuid.v4()

Inherited from EntityBase.uid

Defined in src/EntityBase.ts:13

The universally unique identifier of the object.

version#

• version: number = 0

Inherited from EntityBase.version

Defined in src/EntityBase.ts:28

The optimistic locking version of the object.

Accessors#

ClassName#

• Staticget ClassName(): string

Defined in src/models/Script.ts:44

Returns: string