Skip to main content

Class: WorkspaceModule

A module entry in the workspace configuration.

Extends​

  • BaseClient

Constructors​

Constructor​

new WorkspaceModule(ctx?, _id?, _entrypoint?, _name?, _source?): WorkspaceModule

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

Parameters​

ctx?​

Context

_id?​

ID

_entrypoint?​

boolean

_name?​

string

_source?​

string

Returns​

WorkspaceModule

Overrides​

BaseClient.constructor

Methods​

entrypoint()​

entrypoint(): Promise<boolean>

Whether the module is the workspace entrypoint (functions aliased to Query root).

Returns​

Promise<boolean>

id()​

id(): Promise<ID>

A unique identifier for this WorkspaceModule.

Returns​

Promise<ID>

name()​

name(): Promise<string>

The module name.

Returns​

Promise<string>

settings()​

settings(): Promise<WorkspaceModuleSetting[]>

List constructor-backed settings for this module.

Returns​

Promise<WorkspaceModuleSetting[]>

source()​

source(): Promise<string>

The module source path.

Returns​

Promise<string>