Skip to main content

Func

Represents a function

Extends

Extended by

Constructors

new Func()

new Func(dart): Func

Parameters

ParameterType
dartany

Returns

Func

Overrides

Entity . constructor

Source

src/entities.ts:238

Properties

PropertyModifierTypeInherited from
auxpublicany-
dartpublicanyEntity.dart
optionspublicobject-

Accessors

author

get author(): User

Who created entity *

Returns

User

Source

src/entities.ts:119


createdOn

get createdOn(): Dayjs

Time when entity was created *

Returns

Dayjs

Source

src/entities.ts:110


description

get description(): string

Returns

string

Source

src/entities.ts:245


friendlyName

get friendlyName(): string

Entity friendly name

set friendlyName(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:96


helpUrl

get helpUrl(): string

Help URL.

Returns

string

Source

src/entities.ts:252


id

get id(): string

Entity ID (GUID)

set id(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:88


inputs

get inputs(): Property[]

Input parameters

Returns

Property[]

Source

src/entities.ts:263


name

get name(): string

Entity short name

set name(x): void

Parameters

ParameterType
xstring

Returns

string

Source

src/entities.ts:100


nqName

get nqName(): string

Entity full-qualified name

Returns

string

Source

src/entities.ts:104


outputs

get outputs(): Property[]

Output parameters

Returns

Property[]

Source

src/entities.ts:268


package

get package(): Package

A package this function belongs to.

Returns

Package

Source

src/entities.ts:255


path

get path(): string

Entity path

Returns

string

Source

src/entities.ts:249


type

get type(): string

Returns

string

Source

src/entities.ts:247


updatedOn

get updatedOn(): null | Dayjs

Time when entity was updated *

Returns

null | Dayjs

Source

src/entities.ts:113

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

ParameterType
parametersany[] | object

Returns

Promise<any>

Source

src/entities.ts:276


applySync()

applySync(parameters): any

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

Parameters

ParameterType
parametersobject

Returns

any

Source

src/entities.ts:292


getProperties()

getProperties(): Promise<object>

Gets entity properties

Returns

Promise<object>

Inherited from

Entity . getProperties

Source

src/entities.ts:122


hasTag()

hasTag(tag): boolean

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . hasTag

Source

src/entities.ts:134


newId()

newId(): void

Generates new id for this entity.

Returns

void

Inherited from

Entity . newId

Source

src/entities.ts:92


prepare()

prepare(parameters): FuncCall

Returns FuncCall object in a stand-by state

Parameters

ParameterType
parametersobject

Returns

FuncCall

Source

src/entities.ts:258


setProperties()

setProperties(props): Promise<any>

Sets entity properties

Parameters

ParameterType
propsobject

Returns

Promise<any>

Inherited from

Entity . setProperties

Source

src/entities.ts:127


tag()

tag(tag): boolean

Adds a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . tag

Source

src/entities.ts:137


toString()

toString(): string

Returns a string representing the object

Returns

string

Inherited from

Entity . toString

Source

src/entities.ts:132


unTag()

unTag(tag): boolean

Removes a specified tag

Parameters

ParameterType
tagstring

Returns

boolean

Inherited from

Entity . unTag

Source

src/entities.ts:140


byName()

static byName(name): Func

Returns a function with the specified name.

Parameters

ParameterType
namestring

Returns

Func

Source

src/entities.ts:313


find()

static find(params?): Func[]

Returns functions with the specified attributes.

Parameters

ParameterType
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:297


findAll()

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

Parameters

ParameterType
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:304