Exec
Functionalities to aid code execution.
It performs the execution of other scripts, it also supports the execution of scripts in other programming languages.
Executes the indicated script, returning its output.
Main functions:
// Run another App script in `server/core/`
const outputOutput = _exec.core("other-script");
// Run another App script in `server/services/`
const outputService = _exec.service("other-service");
// Pause for 2 seconds:`
_exec.sleep(2000);
// Execution stop:`
_exec.stop();
add
_exec.add(index: int, element: java.lang.Object) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| element | java.lang.Object |
Return
( Values )
_exec.add(o: java.lang.Object) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| o | java.lang.Object |
Return
( Values )
addAll
_exec.addAll(index: int, c: java.util.Collection<java.lang.Object>) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| c | java.util.Collection |
Return
( boolean )
_exec.addAll(c: java.util.Collection<java.lang.Object>) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| c | java.util.Collection |
Return
( boolean )
afterClose
_exec.afterClose(function: java.util.function.Function<java.lang.Object[], java.lang.Object>) : void
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| function | java.util.function.Function |
Return
( void )
as
_exec.as(o: java.lang.Object) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| o | java.lang.Object |
Return
( Values )
_exec.as(o: java.lang.Object, oDefault: java.lang.Object) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| o | java.lang.Object | |
| oDefault | java.lang.Object |
Return
( Values )
asBoolean
_exec.asBoolean(index: int) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( boolean )
_exec.asBoolean(index: int, defaultValue: boolean) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | boolean |
Return
( boolean )
_exec.asBoolean(key: string) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( boolean )
_exec.asBoolean(key: string, defaultValue: boolean) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | boolean |
Return
( boolean )
asByte
_exec.asByte(index: int) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( byte )
_exec.asByte(index: int, defaultValue: byte) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | byte |
Return
( byte )
_exec.asByte(key: string, defaultValue: byte) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | byte |
Return
( byte )
asCalendar
_exec.asCalendar(index: int) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Calendar )
_exec.asCalendar(index: int, defaultValue: java.util.Calendar) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.util.Calendar |
Return
( java.util.Calendar )
_exec.asCalendar(key: string) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Calendar )
_exec.asCalendar(key: string, defaultValue: java.util.Calendar) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.Calendar |
Return
( java.util.Calendar )
asDate
_exec.asDate(index: int) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Date )
_exec.asDate(index: int, defaultValue: java.util.Date) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.util.Date |
Return
( java.util.Date )
_exec.asDate(key: string) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Date )
_exec.asDate(key: string, defaultValue: java.util.Date) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.Date |
Return
( java.util.Date )
asDouble
_exec.asDouble(index: int) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( double )
_exec.asDouble(index: int, defaultValue: double) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | double |
Return
( double )
_exec.asDouble(key: string) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( double )
_exec.asDouble(key: string, defaultValue: double) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | double |
Return
( double )
asFile
_exec.asFile(index: int) : File
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( File )
_exec.asFile(key: string) : File
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( File )
asFloat
_exec.asFloat(index: int) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( float )
_exec.asFloat(index: int, defaultValue: float) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | float |
Return
( float )
_exec.asFloat(key: string) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( float )
_exec.asFloat(key: string, defaultValue: float) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | float |
Return
( float )
asHTMLDecode
_exec.asHTMLDecode(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
asHTMLEncode
_exec.asHTMLEncode(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
asInstant
_exec.asInstant(index: int) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.Instant )
_exec.asInstant(index: int, defaultValue: java.time.Instant) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.Instant |
Return
( java.time.Instant )
_exec.asInstant(key: string) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.Instant )
_exec.asInstant(key: string, defaultValue: java.time.Instant) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.Instant |
Return
( java.time.Instant )
asInt
_exec.asInt(index: int) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( int )
_exec.asInt(index: int, defaultValue: int) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | int |
Return
( int )
_exec.asInt(key: string, defaultValue: short) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | short |
Return
( int )
asList
_exec.asList(index: int) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.List )
_exec.asList(index: int, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.asList(index: int, defaultValue: java.lang.Object) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object |
Return
( java.util.List )
_exec.asList(index: int, defaultValue: java.lang.Object, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.asList(key: string) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.List )
_exec.asList(key: string, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.asList(key: string, defaultValue: java.lang.Object) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object |
Return
( java.util.List )
_exec.asList(key: string, defaultValue: java.lang.Object, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object | |
| claz | java.lang.Class |
Return
( java.util.List )
asLocalDate
_exec.asLocalDate(index: int) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalDate )
_exec.asLocalDate(index: int, defaultValue: java.time.LocalDate) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalDate |
Return
( java.time.LocalDate )
_exec.asLocalDate(key: string) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalDate )
_exec.asLocalDate(key: string, defaultValue: java.time.LocalDate) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalDate |
Return
( java.time.LocalDate )
asLocalDateTime
_exec.asLocalDateTime(index: int) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalDateTime )
_exec.asLocalDateTime(index: int, defaultValue: java.time.LocalDateTime) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalDateTime |
Return
( java.time.LocalDateTime )
_exec.asLocalDateTime(key: string) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalDateTime )
_exec.asLocalDateTime(key: string, defaultValue: java.time.LocalDateTime) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalDateTime |
Return
( java.time.LocalDateTime )
asLocalTime
_exec.asLocalTime(index: int) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalTime )
_exec.asLocalTime(index: int, defaultValue: java.time.LocalTime) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalTime |
Return
( java.time.LocalTime )
_exec.asLocalTime(key: string) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalTime )
_exec.asLocalTime(key: string, defaultValue: java.time.LocalTime) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalTime |
Return
( java.time.LocalTime )
asLong
_exec.asLong(index: int) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( long )
_exec.asLong(index: int, defaultValue: long) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | long |
Return
( long )
_exec.asLong(key: string) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( long )
_exec.asLong(key: string, defaultValue: long) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | long |
Return
( long )
asMap
_exec.asMap(index: int) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Map )
_exec.asMap(index: int, defaultValue: java.lang.Object) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object |
Return
( java.util.Map )
_exec.asMap(key: string) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Map )
_exec.asMap(key: string, defaultValue: java.lang.Object) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object |
Return
( java.util.Map )
asSQLDate
_exec.asSQLDate(index: int) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Date )
_exec.asSQLDate(index: int, defaultValue: java.sql.Date) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Date |
Return
( java.sql.Date )
_exec.asSQLDate(key: string) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Date )
_exec.asSQLDate(key: string, defaultValue: java.sql.Date) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Date |
Return
( java.sql.Date )
asSQLTime
_exec.asSQLTime(index: int) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Time )
_exec.asSQLTime(index: int, defaultValue: java.sql.Time) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Time |
Return
( java.sql.Time )
_exec.asSQLTime(key: string) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Time )
_exec.asSQLTime(key: string, defaultValue: java.sql.Time) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Time |
Return
( java.sql.Time )
asSQLTimestamp
_exec.asSQLTimestamp(index: int) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Timestamp )
_exec.asSQLTimestamp(index: int, defaultValue: java.sql.Timestamp) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Timestamp |
Return
( java.sql.Timestamp )
_exec.asSQLTimestamp(key: string) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Timestamp )
_exec.asSQLTimestamp(key: string, defaultValue: java.sql.Timestamp) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Timestamp |
Return
( java.sql.Timestamp )
asShort
_exec.asShort(index: int) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( short )
_exec.asShort(index: int, defaultValue: short) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | short |
Return
( short )
_exec.asShort(key: string) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( short )
_exec.asShort(key: string, defaultValue: short) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | short |
Return
( short )
asString
_exec.asString(index: int) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( string )
_exec.asString(index: int, defaultValue: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | string |
Return
( string )
_exec.asString(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
_exec.asString(key: string, defaultValue: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | string |
Return
( string )
_exec.asString(key: string, defaultValue: string, charsetName: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | string | |
| charsetName | string |
Return
( string )
asUID
_exec.asUID(key: string) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.UUID )
_exec.asUID(key: string, defaultValue: string) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | string |
Return
( java.util.UUID )
_exec.asUID(key: string, defaultValue: java.util.UUID) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.UUID |
Return
( java.util.UUID )
asUUID
_exec.asUUID(key: string) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.UUID )
_exec.asUUID(key: string, defaultValue: string) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | string |
Return
( java.util.UUID )
_exec.asUUID(key: string, defaultValue: java.util.UUID) : java.util.UUID
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.UUID |
Return
( java.util.UUID )
asValues
_exec.asValues(index: int) : Values
Description
Gets the object associated with the index and then casts to Values (Dictionary or List).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | The index to get the associated object. |
Return
( Values )
Object converted to Values.
_exec.asValues(index: int, defaultValue: java.lang.Object) : Values
Description
Gets the object associated with the index and then casts to Values (Dictionary or List).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | The index to get the associated object. |
| defaultValue | java.lang.Object | If it fails to get the value as an object in Values then it returns this default value instead. |
Return
( Values )
Object converted to Values.
_exec.asValues(key: string) : Values
Description
Gets the object associated with the key and then casts to Values (Dictionary or List).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | The key to get the associated object. |
Return
( Values )
Object converted to Values.
_exec.asValues(key: string, defaultValue: java.lang.Object) : Values
Description
Gets the object associated with the key and then casts to Values (Dictionary or List).
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | The key to get the associated object. |
| defaultValue | java.lang.Object | If it fails to get the value as an object in Values then it returns this default value instead. |
Return
( Values )
Object converted to Values.
baseFile
_exec.baseFile(value: java.lang.Object, key: string, content: string) : File
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| value | java.lang.Object | |
| key | string | |
| content | string |
Return
( File )
beforeClose
_exec.beforeClose(function: java.util.function.Function<java.lang.Object[], java.lang.Object>) : void
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| function | java.util.function.Function |
Return
( void )
bind
_exec.bind(key: string, value: java.lang.Object) : Exec
Description
Transitions variables between scripts, including between different programming languages.
How To Use
const originalVar = "test";
_exec .bind("transitVar", originalVar) .core("another-script-maybe-in-another-language");
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | Variable name that will be available in the other script that will be executed. |
| value | java.lang.Object | Object to be passed to the other script that will be executed. |
Return
( Exec )
cj
_exec.cj(id: string, code: string) : ScriptResult
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| id | string | |
| code | string |
Return
( ScriptResult )
_exec.cj(id: string, code: string, bindings: Values) : ScriptResult
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| id | string | |
| code | string | |
| bindings | Values |
Return
( ScriptResult )
clear
_exec.clear() : void
Return
( void )
cloneJSON
_exec.cloneJSON() : Values
Return
( Values )
compute
_exec.compute(arg0: ?, arg1: java.util.function.BiFunction<?, ?, ?>) : ?
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| arg0 | java.lang.Object | |
| arg1 | java.util.function.BiFunction |
Return
( java.lang.Object )
computeIfAbsent
_exec.computeIfAbsent(arg0: ?, arg1: java.util.function.Function<?, ?>) : ?
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| arg0 | java.lang.Object | |
| arg1 | java.util.function.Function |
Return
( java.lang.Object )
computeIfPresent
_exec.computeIfPresent(arg0: ?, arg1: java.util.function.BiFunction<?, ?, ?>) : ?
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| arg0 | java.lang.Object | |
| arg1 | java.util.function.BiFunction |
Return
( java.lang.Object )
contains
_exec.contains(o: java.lang.Object) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| o | java.lang.Object |
Return
( boolean )
_exec.contains(key: string, value: java.lang.Object) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| value | java.lang.Object |
Return
( boolean )
containsAll
_exec.containsAll(c: java.util.Collection<?>) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| c | java.util.Collection |
Return
( boolean )
containsKey
_exec.containsKey(key: java.lang.Object) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | java.lang.Object |
Return
( boolean )
containsValue
_exec.containsValue(value: java.lang.Object) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| value | java.lang.Object |
Return
( boolean )
core
_exec.core(path: string) : ScriptResult
Description
Execution of scripts that are in the server/core/ folder.
How To Use
_exec.core("another-script-maybe-in-another-language");
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | Script path with source in core/ to execute. |
Return
( ScriptResult )
_exec.core(path: string, path: boolean) : ScriptResult
Description
Execution of scripts that are in the server/core/ folder.
How To Use
_exec.core("another-script-maybe-in-another-language");
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| path | string | Script path with source in core/ to execute. |
| path | boolean | Script path with source in core/ to execute. |
Return
( ScriptResult )
debug
_exec.debug() : void
Return
( void )
ensureJail
_exec.ensureJail(jailPath: string) : void
Description
Set the security restriction on a specific directory for processed objects of the file type, it can only be set once.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| jailPath | string | Path where files will be restricted. |
Return
( void )
entrySet
_exec.entrySet() : java.util.Set<java.util.Map$Entry<string, java.lang.Object>>
Return
( java.util.Set )
filter
_exec.filter(p: java.util.function.Predicate<java.lang.Object>) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| p | java.util.function.Predicate |
Return
( Values )
_exec.filter(function: org.graalvm.polyglot.Value) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| function | org.graalvm.polyglot.Value |
Return
( Values )
find
_exec.find(key: string, value: java.lang.Object) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| value | java.lang.Object |
Return
( Values )
_exec.find(p: java.util.function.Predicate<java.lang.Object>) : java.lang.Object
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| p | java.util.function.Predicate |
Return
( java.lang.Object )
_exec.find(function: org.graalvm.polyglot.Value) : java.lang.Object
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| function | org.graalvm.polyglot.Value |
Return
( java.lang.Object )
_exec.find(filter: Values) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| filter | Values |
Return
( Values )
forEach
_exec.forEach(action: java.util.function.BiConsumer<?, ?>) : void
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| action | java.util.function.BiConsumer |
Return
( void )
_exec.forEach(action: java.util.function.Consumer<?>) : void
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| action | java.util.function.Consumer |
Return
( void )
_exec.forEach(function: org.graalvm.polyglot.Value) : void
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| function | org.graalvm.polyglot.Value |
Return
( void )
forceList
_exec.forceList() : Values
Return
( Values )
forceMap
_exec.forceMap() : Values
Return
( Values )
fromJSON
_exec.fromJSON(content: string) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| content | string |
Return
( Values )
_exec.fromJSON(content: org.netuno.psamata.net.Remote$Response) : Values
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| content | org.netuno.psamata.net.Remote$Response |
Return
( Values )
functions
_exec.functions() : Functions
Description
Manages the execution of functions.
Return
( Functions )
_exec.functions(functions: java.util.function.Function[]) : Functions
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| functions | java.util.function.Function[] |
Return
( Functions )
_exec.functions(data: java.lang.Object) : Functions
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| data | java.lang.Object |
Return
( Functions )
_exec.functions(data: java.lang.Object, functions: java.util.function.Function[]) : Functions
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| data | java.lang.Object | |
| functions | java.util.function.Function[] |
Return
( Functions )
gc
_exec.gc() : void
Description
Performs memory cleanup by running the garbage collector (JVM garbage collector).
How To Use
// Free up memory by running Garbage Collector:
_exec.gc();
Return
( void )
get
_exec.get(key: int) : ?
Description
Gets the original object associated with the key.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | int | Key to get the object to associate. |
Return
( java.lang.Object )
Original object without conversions.
_exec.get(key: java.lang.Object) : java.lang.Object
Description
Gets the original object associated with the key.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | java.lang.Object | Key to get the object to associate. |
Return
( java.lang.Object )
Original object without conversions.
_exec.get(key: string) : ?
Description
Gets the original object associated with the key.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | Key to get the object to associate. |
Return
( java.lang.Object )
Original object without conversions.
_exec.get(key: string, type: java.lang.Class<?>) : ?
Description
Gets the original object associated with the key, but cast for the specified class type.
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | Key to get the associated object. |
| type | java.lang.Class | Class representing the type of object that should be cast. |
Return
( java.lang.Object )
Original object converted to the type of the defined class.
getBoolean
_exec.getBoolean(index: int) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( boolean )
_exec.getBoolean(index: int, defaultValue: boolean) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | boolean |
Return
( boolean )
_exec.getBoolean(key: string) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( boolean )
_exec.getBoolean(key: string, defaultValue: boolean) : boolean
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | boolean |
Return
( boolean )
getByte
_exec.getByte(index: int) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( byte )
_exec.getByte(index: int, defaultValue: byte) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | byte |
Return
( byte )
_exec.getByte(key: string) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( byte )
_exec.getByte(key: string, defaultValue: byte) : byte
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | byte |
Return
( byte )
getCalendar
_exec.getCalendar(index: int) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Calendar )
_exec.getCalendar(index: int, defaultValue: java.util.Calendar) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.util.Calendar |
Return
( java.util.Calendar )
_exec.getCalendar(key: string) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Calendar )
_exec.getCalendar(key: string, defaultValue: java.util.Calendar) : java.util.Calendar
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.Calendar |
Return
( java.util.Calendar )
getDate
_exec.getDate(index: int) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Date )
_exec.getDate(index: int, defaultValue: java.util.Date) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.util.Date |
Return
( java.util.Date )
_exec.getDate(key: string) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Date )
_exec.getDate(key: string, defaultValue: java.util.Date) : java.util.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.util.Date |
Return
( java.util.Date )
getDouble
_exec.getDouble(index: int) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( double )
_exec.getDouble(index: int, defaultValue: double) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | double |
Return
( double )
_exec.getDouble(key: string) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( double )
_exec.getDouble(key: string, defaultValue: double) : double
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | double |
Return
( double )
getFile
_exec.getFile(index: int) : File
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( File )
_exec.getFile(key: string) : File
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( File )
getFloat
_exec.getFloat(index: int) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( float )
_exec.getFloat(index: int, defaultValue: float) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | float |
Return
( float )
_exec.getFloat(key: string) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( float )
_exec.getFloat(key: string, defaultValue: float) : float
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | float |
Return
( float )
getForceList
_exec.getForceList() : boolean
Return
( boolean )
getForceMap
_exec.getForceMap() : boolean
Return
( boolean )
getHTMLDecode
_exec.getHTMLDecode(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
getHTMLEncode
_exec.getHTMLEncode(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
getInstant
_exec.getInstant(index: int) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.Instant )
_exec.getInstant(index: int, defaultValue: java.time.Instant) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.Instant |
Return
( java.time.Instant )
_exec.getInstant(key: string) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.Instant )
_exec.getInstant(key: string, defaultValue: java.time.Instant) : java.time.Instant
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.Instant |
Return
( java.time.Instant )
getInt
_exec.getInt(index: int) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( int )
_exec.getInt(index: int, defaultValue: int) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | int |
Return
( int )
_exec.getInt(key: string) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( int )
_exec.getInt(key: string, defaultValue: int) : int
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | int |
Return
( int )
getKeys
_exec.getKeys() : java.util.Set<string>
Return
( java.util.Set )
getList
_exec.getList(index: int) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.List )
_exec.getList(index: int, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.getList(index: int, defaultValue: java.lang.Object) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object |
Return
( java.util.List )
_exec.getList(index: int, defaultValue: java.lang.Object, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.getList(key: string) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.List )
_exec.getList(key: string, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| claz | java.lang.Class |
Return
( java.util.List )
_exec.getList(key: string, defaultValue: java.lang.Object) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object |
Return
( java.util.List )
_exec.getList(key: string, defaultValue: java.lang.Object, claz: java.lang.Class<?>) : java.util.List<?>
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object | |
| claz | java.lang.Class |
Return
( java.util.List )
getLocalDate
_exec.getLocalDate(index: int) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalDate )
_exec.getLocalDate(index: int, defaultValue: java.time.LocalDate) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalDate |
Return
( java.time.LocalDate )
_exec.getLocalDate(key: string) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalDate )
_exec.getLocalDate(key: string, defaultValue: java.time.LocalDate) : java.time.LocalDate
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalDate |
Return
( java.time.LocalDate )
getLocalDateTime
_exec.getLocalDateTime(index: int) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalDateTime )
_exec.getLocalDateTime(index: int, defaultValue: java.time.LocalDateTime) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalDateTime |
Return
( java.time.LocalDateTime )
_exec.getLocalDateTime(key: string) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalDateTime )
_exec.getLocalDateTime(key: string, defaultValue: java.time.LocalDateTime) : java.time.LocalDateTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalDateTime |
Return
( java.time.LocalDateTime )
getLocalTime
_exec.getLocalTime(index: int) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.time.LocalTime )
_exec.getLocalTime(index: int, defaultValue: java.time.LocalTime) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.time.LocalTime |
Return
( java.time.LocalTime )
_exec.getLocalTime(key: string) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.time.LocalTime )
_exec.getLocalTime(key: string, defaultValue: java.time.LocalTime) : java.time.LocalTime
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.time.LocalTime |
Return
( java.time.LocalTime )
getLong
_exec.getLong(index: int) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( long )
_exec.getLong(index: int, defaultValue: long) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | long |
Return
( long )
_exec.getLong(key: string) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( long )
_exec.getLong(key: string, defaultValue: long) : long
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | long |
Return
( long )
getMap
_exec.getMap(index: int) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.util.Map )
_exec.getMap(index: int, defaultValue: java.lang.Object) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.lang.Object |
Return
( java.util.Map )
_exec.getMap(key: string) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.util.Map )
_exec.getMap(key: string, defaultValue: java.lang.Object) : Values | DataSchema | java.util.Map
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.lang.Object |
Return
( java.util.Map )
getOrDefault
_exec.getOrDefault(arg0: java.lang.Object, arg1: ?) : ?
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| arg0 | java.lang.Object | |
| arg1 | java.lang.Object |
Return
( java.lang.Object )
getSQLDate
_exec.getSQLDate(index: int) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Date )
_exec.getSQLDate(index: int, defaultValue: java.sql.Date) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Date |
Return
( java.sql.Date )
_exec.getSQLDate(key: string) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Date )
_exec.getSQLDate(key: string, defaultValue: java.sql.Date) : java.sql.Date
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Date |
Return
( java.sql.Date )
getSQLTime
_exec.getSQLTime(index: int) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Time )
_exec.getSQLTime(index: int, defaultValue: java.sql.Time) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Time |
Return
( java.sql.Time )
_exec.getSQLTime(key: string) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Time )
_exec.getSQLTime(key: string, defaultValue: java.sql.Time) : java.sql.Time
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Time |
Return
( java.sql.Time )
getSQLTimestamp
_exec.getSQLTimestamp(index: int) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( java.sql.Timestamp )
_exec.getSQLTimestamp(index: int, defaultValue: java.sql.Timestamp) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | java.sql.Timestamp |
Return
( java.sql.Timestamp )
_exec.getSQLTimestamp(key: string) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( java.sql.Timestamp )
_exec.getSQLTimestamp(key: string, defaultValue: java.sql.Timestamp) : java.sql.Timestamp
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | java.sql.Timestamp |
Return
( java.sql.Timestamp )
getShort
_exec.getShort(index: int) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( short )
_exec.getShort(index: int, defaultValue: short) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | short |
Return
( short )
_exec.getShort(key: string) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( short )
_exec.getShort(key: string, defaultValue: short) : short
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | short |
Return
( short )
getSize
_exec.getSize() : int
Return
( int )
getString
_exec.getString(index: int) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int |
Return
( string )
_exec.getString(index: int, defaultValue: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| index | int | |
| defaultValue | string |
Return
( string )
_exec.getString(key: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string |
Return
( string )
_exec.getString(key: string, defaultValue: string) : string
Attributes
| NAME | TYPE | DESCRIPTION |
|---|---|---|
| key | string | |
| defaultValue | string |
Return
( string )