Func

Represents a function

Extends

• Entity

Extended by

• DataQuery
• DataJob
• Script

Constructors

new Func()

new Func(dart): Func

Parameters

Parameter	Type
dart	any

Returns

Func

Overrides

Entity . constructor

Source

src/entities.ts:253

Properties

Property	Modifier	Type	Inherited from
aux	public	any	-
dart	public	any	Entity.dart
options	public	object	-

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:125

---

createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:116

---

description

get description(): string

Returns

string

Source

src/entities.ts:260

---

friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:102

---

helpUrl

get helpUrl(): string

Help URL.

set helpUrl(url): void

Parameters

Parameter	Type
url	string

Returns

string

Source

src/entities.ts:267

---

id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:94

---

inputs

get inputs(): Property[]

Input parameters

Returns

Property[]

Source

src/entities.ts:290

---

isVectorFunc

get isVectorFunc(): boolean

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

Source

src/entities.ts:277

---

name

get name(): string

Entity short name

set name(x): void

Parameters

Parameter	Type
x	string

Returns

string

Source

src/entities.ts:106

---

nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:110

---

outputs

get outputs(): Property[]

Output parameters

Returns

Property[]

Source

src/entities.ts:295

---

package

get package(): Package

A package this function belongs to.

Returns

Package

Source

src/entities.ts:272

---

path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:264

---

type

get type(): string

Returns

string

Source

src/entities.ts:262

---

updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:119

Methods

apply()

apply(parameters): Promise<any>

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[] | object

Returns

Promise<any>

Source

src/entities.ts:303

---

applySync()

applySync(parameters): any

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

Parameters

Parameter	Type
parameters	object

Returns

any

Source

src/entities.ts:319

---

getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:128

---

hasTag()

hasTag(tag): boolean

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:140

---

newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:98

---

prepare()

prepare(parameters): FuncCall

Returns FuncCall object in a stand-by state

Parameters

Parameter	Type
parameters	object

Returns

FuncCall

Source

src/entities.ts:280

---

prepareAsync()

prepareAsync(parameters): Promise <FuncCall>

Parameters

Parameter	Type
parameters	object

Returns

Promise <FuncCall>

Source

src/entities.ts:284

---

setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

Parameter	Type
props	object

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:133

---

tag()

tag(tag): boolean

Adds a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:143

---

toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:138

---

unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

Parameter	Type
tag	string

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:146

---

byName()

static byName(name): Func

Returns a function with the specified name.

Parameters

Parameter	Type
name	string

Returns

Func

Source

src/entities.ts:340

---

find()

static find(params?): Func[]

Returns functions with the specified attributes.

Parameters

Parameter	Type
params?	object
params.meta?	any
params.name?	string
params.package?	string
params.returnSemType?	string
params.returnType?	string
params.tags?	string[]

Returns

Func[]

Source

src/entities.ts:324

---

findAll()

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

Parameters

Parameter	Type
params?	object
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.

Source

src/entities.ts:331