Class: Func
dg.Func
Represents a function
Hierarchy
Constructors
constructor
• new Func(dart
)
Parameters
Name | Type |
---|---|
dart | any |
Overrides
Defined in
Properties
aux
• aux: any
Defined in
dart
• dart: any
Inherited from
Defined in
options
• options: Object
Index signature
▪ [key: string
]: any
Defined in
Accessors
author
• get
author(): User
Who created entity *
Returns
Inherited from
Entity.author
Defined in
createdOn
• get
createdOn(): Dayjs
Time when entity was created *
Returns
Dayjs
Inherited from
Entity.createdOn
Defined in
description
• get
description(): string
Returns
string
Defined in
friendlyName
• get
friendlyName(): string
Entity friendly name
Returns
string
Inherited from
Entity.friendlyName
Defined in
• set
friendlyName(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.friendlyName
Defined in
helpUrl
• get
helpUrl(): string
Help URL.
Returns
string
Defined in
id
• get
id(): string
Entity ID (GUID)
Returns
string
Inherited from
Entity.id
Defined in
• set
id(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.id
Defined in
inputs
• get
inputs(): Property
[]
Input parameters
Returns
Property
[]
Defined in
name
• get
name(): string
Entity short name
Returns
string
Inherited from
Entity.name
Defined in
• set
name(x
): void
Parameters
Name | Type |
---|---|
x | string |
Returns
void
Inherited from
Entity.name
Defined in
nqName
• get
nqName(): string
Entity full-qualified name
Returns
string
Inherited from
Entity.nqName
Defined in
outputs
• get
outputs(): Property
[]
Output parameters
Returns
Property
[]
Defined in
package
• get
package(): Package
A package this function belongs to.
Returns
Defined in
path
• get
path(): string
Entity path
Returns
string
Overrides
Entity.path
Defined in
type
• get
type(): string
Returns
string
Defined in
updatedOn
• get
updatedOn(): Dayjs
Time when entity was updated *
Returns
Dayjs
Inherited from
Entity.updatedOn
Defined in
Methods
apply
▸ apply(parameters?
): Promise
<any
>
Executes the function with the specified {link parameters}, and returns result. If necessary, the corresponding package will be loaded as part of the call.
Parameters
Name | Type |
---|---|
parameters | any [] | { [name: string] : any ; } |
Returns
Promise
<any
>
Defined in
applySync
▸ applySync(parameters?
): any
Executes the function synchronously, and returns the result. If the function is asynchronous, throws an exception.
Parameters
Name | Type |
---|---|
parameters | Object |
Returns
any
Defined in
getProperties
▸ getProperties(): Promise
<{ [index: string]
: any
; }>
Gets entity properties
Returns
Promise
<{ [index: string]
: any
; }>
Inherited from
Defined in
hasTag
▸ hasTag(tag
): boolean
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
newId
▸ newId(): void
Generates new id for this entity.
Returns
void
Inherited from
Defined in
prepare
▸ prepare(parameters?
): FuncCall
Returns FuncCall object in a stand-by state
Parameters
Name | Type |
---|---|
parameters | Object |
Returns
Defined in
setProperties
▸ setProperties(props
): Promise
<any
>
Sets entity properties
Parameters
Name | Type |
---|---|
props | Object |
Returns
Promise
<any
>
Inherited from
Defined in
tag
▸ tag(tag
): boolean
Adds a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
toString
▸ toString(): string
Returns a string representing the object
Returns
string
Inherited from
Defined in
unTag
▸ unTag(tag
): boolean
Removes a specified tag
Parameters
Name | Type |
---|---|
tag | string |
Returns
boolean
Inherited from
Defined in
byName
▸ Static
byName(name
): Func
Returns a function with the specified name.
Parameters
Name | Type |
---|---|
name | string |
Returns
Defined in
find
▸ Static
find(params?
): Func
[]
Returns functions with the specified attributes.
Parameters
Name | Type |
---|---|
params? | Object |
params.meta? | any |
params.name? | string |
params.package? | string |
params.returnSemType? | string |
params.returnType? | string |
params.tags? | string [] |
Returns
Func
[]
Defined in
findAll
▸ Static
findAll(params?
): Promise
<Func
[]>
Deprecated
Use find, it's the same now but does not make a server query and synchronous.
Parameters
Name | Type |
---|---|
params? | Object |
params.meta? | any |
params.name? | string |
params.package? | string |
params.returnSemType? | string |
params.returnType? | string |
params.tags? | string [] |
Returns
Promise
<Func
[]>