Func

Defined in: src/entities/func.ts:25

Represents a function

Extends

• Entity

Extended by

• Script
• DataQuery
• DataJob

Constructors

Constructor

new Func(dart): Func

Defined in: src/entities/func.ts:29

Parameters

Parameter	Type
dart	any

Returns

Func

Overrides

Entity.constructor

Properties

Property	Modifier	Type	Inherited from	Defined in
aux	public	any	-	src/entities/func.ts:26
dart	public	any	Entity.dart	src/entities/entity.ts:19
options	public	object	-	src/entities/func.ts:27

Accessors

author

Get Signature

get author(): any

Defined in: src/entities/entity.ts:59

Who created entity *

Returns

any

Inherited from

Entity.author

---

createdOn

Get Signature

get createdOn(): Dayjs

Defined in: src/entities/entity.ts:50

Time when entity was created *

Returns

Dayjs

Inherited from

Entity.createdOn

---

description

Get Signature

get description(): string

Defined in: src/entities/func.ts:36

Returns

string

---

entityType

Get Signature

get entityType(): string

Defined in: src/entities/entity.ts:66

Entity type name *

Returns

string

Inherited from

Entity.entityType

---

friendlyName

Get Signature

get friendlyName(): string

Defined in: src/entities/entity.ts:36

Entity friendly name

Returns

string

Set Signature

set friendlyName(x): void

Defined in: src/entities/entity.ts:37

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.friendlyName

---

helpUrl

Get Signature

get helpUrl(): string

Defined in: src/entities/func.ts:43

Help URL.

Returns

string

Set Signature

set helpUrl(url): void

Defined in: src/entities/func.ts:45

Parameters

Parameter	Type
url	string

Returns

void

---

id

Get Signature

get id(): string

Defined in: src/entities/entity.ts:28

Entity ID (GUID)

Returns

string

Set Signature

set id(x): void

Defined in: src/entities/entity.ts:29

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.id

---

inputs

Get Signature

get inputs(): Property[]

Defined in: src/entities/func.ts:66

Input parameters

Returns

Property[]

---

isVectorFunc

Get Signature

get isVectorFunc(): boolean

Defined in: src/entities/func.ts:53

Indicates that the function (or script) is already vector, meaning it accepts vector input (an entire column) and processes it in a single call, rather than being executed separately for each scalar element (row)

Returns

boolean

---

name

Get Signature

get name(): string

Defined in: src/entities/entity.ts:40

Entity short name

Returns

string

Set Signature

set name(x): void

Defined in: src/entities/entity.ts:41

Parameters

Parameter	Type
x	string

Returns

void

Inherited from

Entity.name

---

nqName

Get Signature

get nqName(): string

Defined in: src/entities/entity.ts:44

Entity full-qualified name

Returns

string

Inherited from

Entity.nqName

---

outputs

Get Signature

get outputs(): Property[]

Defined in: src/entities/func.ts:71

Output parameters

Returns

Property[]

---

package

Get Signature

get package(): any

Defined in: src/entities/func.ts:48

A package this function belongs to.

Returns

any

---

path

Get Signature

get path(): string

Defined in: src/entities/func.ts:40

Entity path

Returns

string

Overrides

Entity.path

---

type

Get Signature

get type(): string

Defined in: src/entities/func.ts:38

Returns

string

---

updatedOn

Get Signature

get updatedOn(): Dayjs | null

Defined in: src/entities/entity.ts:53

Time when entity was updated *

Returns

Dayjs | null

Inherited from

Entity.updatedOn

Methods

apply()

apply(parameters?): Promise<any>

Defined in: src/entities/func.ts:79

Executes the function with the specified parameters, and returns result. If necessary, the corresponding package will be loaded as part of the call.

Parameters

Parameter	Type
parameters	any[] | {[name: string]: any; }

Returns

Promise<any>

---

applySync()

applySync(parameters?): any

Defined in: src/entities/func.ts:95

Executes the function synchronously, and returns the result. If the function is asynchronous, throws an exception.

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

any

---

getProperties()

getProperties(): Promise<{[index: string]: any; }>

Defined in: src/entities/entity.ts:69

Gets entity properties

Returns

Promise<{[index: string]: any; }>

Inherited from

Entity.getProperties

---

hasTag()

hasTag(tag): boolean

Defined in: src/entities/entity.ts:81

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.hasTag

---

newId()

newId(): void

Defined in: src/entities/entity.ts:32

Generates new id for this entity.

Returns

void

Inherited from

Entity.newId

---

prepare()

prepare(parameters?): FuncCall

Defined in: src/entities/func.ts:56

Returns FuncCall object in a stand-by state

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

FuncCall

---

prepareAsync()

prepareAsync(parameters?): Promise<FuncCall>

Defined in: src/entities/func.ts:60

Parameters

Parameter	Type
parameters	{[name: string]: any; }

Returns

Promise<FuncCall>

---

setProperties()

setProperties(props): Promise<any>

Defined in: src/entities/entity.ts:74

Sets entity properties

Parameters

Parameter	Type
props	{[index: string]: any; }

Returns

Promise<any>

Inherited from

Entity.setProperties

---

tag()

tag(tag): boolean

Defined in: src/entities/entity.ts:84

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.tag

---

toString()

toString(): string

Defined in: src/entities/entity.ts:79

Returns a string representing the object

Returns

string

Inherited from

Entity.toString

---

unTag()

unTag(tag): boolean

Defined in: src/entities/entity.ts:87

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity.unTag

---

byName()

static byName(name): Func

Defined in: src/entities/func.ts:116

Returns a function with the specified name.

Parameters

Parameter	Type
name	string

Returns

Func

---

find()

static find(params?): Func[]

Defined in: src/entities/func.ts:100

Returns functions with the specified attributes.

Parameters

Parameter	Type
params?	{ meta?: any; name?: string; package?: string; returnSemType?: string; returnType?: string; tags?: string[]; }
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Func[]

---

findAll()

static findAll(params?): Promise<Func[]>

Defined in: src/entities/func.ts:107

Parameters

Parameter	Type
params?	{ meta?: any; name?: string; package?: string; returnSemType?: string; returnType?: string; tags?: string[]; }
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Promise<Func[]>

Deprecated

Use find, it's the same now but does not make a server query and synchronous.