Dagger NodeJS SDK
api/client.gen.FunctionCall
An active function call.
Hierarchy
-
BaseClient
↳
FunctionCall
Constructors
constructor
new FunctionCall(parent?
, _id?
, _name?
, _parent?
, _parentName?
, _returnValue?
): FunctionCall
Constructor is used for internal usage only, do not create object from it.
Parameters
Name | Type |
---|---|
parent? | Object |
parent.ctx | Context |
parent.queryTree? | QueryTree [] |
_id? | FunctionCallID |
_name? | string |
_parent? | JSON |
_parentName? | string |
_returnValue? | Void |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private
Optional
Readonly
_id: FunctionCallID
= undefined
_name
Private
Optional
Readonly
_name: string
= undefined
_parent
Private
Optional
Readonly
_parent: JSON
= undefined
_parentName
Private
Optional
Readonly
_parentName: string
= undefined
_returnValue
Private
Optional
Readonly
_returnValue: Void
= undefined
Methods
id
id(): Promise
<FunctionCallID
>
A unique identifier for this FunctionCall.
Returns
Promise
<FunctionCallID
>
inputArgs
inputArgs(): Promise
<FunctionCallArgValue
[]>
The argument values the function is being invoked with.
Returns
Promise
<FunctionCallArgValue
[]>
name
name(): Promise
<string
>
The name of the function being called.
Returns
Promise
<string
>
parent
parent(): Promise
<JSON
>
The value of the parent object of the function being called. If the function is top-level to the module, this is always an empty object.
Returns
Promise
<JSON
>
parentName
parentName(): Promise
<string
>
The name of the parent object of the function being called. If the function is top-level to the module, this is the name of the module.
Returns
Promise
<string
>
returnValue
returnValue(value
): Promise
<Void
>
Set the return value of the function call to the provided value.
Parameters
Name | Type | Description |
---|---|---|
value | JSON | JSON serialization of the return value. |
Returns
Promise
<Void
>