Skip to main content

Class: CurrentModuleAsSDKClient

A generated client the current SDK produces in the workspace.

Extends

  • BaseClient

Constructors

Constructor

new CurrentModuleAsSDKClient(ctx?, _id?, _module?, _path?, _pin?): CurrentModuleAsSDKClient

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

Parameters

ctx?

Context

_id?

ID

_module?

string

_path?

string

_pin?

string

Returns

CurrentModuleAsSDKClient

Overrides

BaseClient.constructor

Methods

id()

id(): Promise<ID>

A unique identifier for this CurrentModuleAsSDKClient.

Returns

Promise<ID>


module_()

module_(): Promise<string>

The module the client is bound to (workspace-relative path or canonical ref).

Returns

Promise<string>


path()

path(): Promise<string>

Workspace-root-relative path of the generated client.

Returns

Promise<string>


pin()

pin(): Promise<string>

The pinned version of the bound module, if any.

Returns

Promise<string>