Skip to main content

Dagger NodeJS SDK

api/client.gen.LocalModuleSource

Module source that that originates from a path locally relative to an arbitrary directory.

Hierarchy​

  • BaseClient

    ↳ LocalModuleSource

Constructors​

constructor​

new LocalModuleSource(parent?, _id?, _rootSubpath?): LocalModuleSource

Constructor is used for internal usage only, do not create object from it.

Parameters​

NameType
parent?Object
parent.ctxContext
parent.queryTree?QueryTree[]
_id?LocalModuleSourceID
_rootSubpath?string

Returns​

LocalModuleSource

Overrides​

BaseClient.constructor

Properties​

_id​

Private Optional Readonly _id: LocalModuleSourceID = undefined

_rootSubpath​

Private Optional Readonly _rootSubpath: string = undefined

Methods​

contextDirectory​

contextDirectory(): Directory

The directory containing everything needed to load load and use the module.

Returns​

Directory

id​

id(): Promise<LocalModuleSourceID>

A unique identifier for this LocalModuleSource.

Returns​

Promise<LocalModuleSourceID>

rootSubpath​

rootSubpath(): Promise<string>

The path to the root of the module source under the context directory. This directory contains its configuration file. It also contains its source code (possibly as a subdirectory).

Returns​

Promise<string>