Dagger NodeJS SDK
api/client.gen.GeneratedCode
The result of running an SDK's codegen.
Hierarchy
-
BaseClient↳
GeneratedCode
Constructors
constructor
new GeneratedCode(parent?, _id?): GeneratedCode
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? | GeneratedCodeID |
Returns
Overrides
BaseClient.constructor
Properties
_id
Private Optional Readonly _id: GeneratedCodeID = undefined
Methods
code
code(): Directory
The directory containing the generated code.
Returns
id
id(): Promise<GeneratedCodeID>
A unique identifier for this GeneratedCode.
Returns
Promise<GeneratedCodeID>
vcsGeneratedPaths
vcsGeneratedPaths(): Promise<string[]>
List of paths to mark generated in version control (i.e. .gitattributes).
Returns
Promise<string[]>
vcsIgnoredPaths
vcsIgnoredPaths(): Promise<string[]>
List of paths to ignore in version control (i.e. .gitignore).
Returns
Promise<string[]>
with
with(arg): GeneratedCode
Call the provided function with current GeneratedCode.
This is useful for reusability and readability by not breaking the calling chain.
Parameters
| Name | Type |
|---|---|
arg | (param: GeneratedCode) => GeneratedCode |
Returns
withVCSGeneratedPaths
withVCSGeneratedPaths(paths): GeneratedCode
Set the list of paths to mark generated in version control.
Parameters
| Name | Type |
|---|---|
paths | string[] |
Returns
withVCSIgnoredPaths
withVCSIgnoredPaths(paths): GeneratedCode
Set the list of paths to ignore in version control.
Parameters
| Name | Type |
|---|---|
paths | string[] |