Skip to main content

Class: Up

Extends​

  • BaseClient

Constructors​

Constructor​

new Up(ctx?, _id?, _description?, _name?): Up

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

Parameters​

ctx?​

Context

_id?​

UpID

_description?​

string

_name?​

string

Returns​

Up

Overrides​

BaseClient.constructor

Methods​

description()​

description(): Promise<string>

The description of the service

Returns​

Promise<string>

id()​

id(): Promise<UpID>

A unique identifier for this Up.

Returns​

Promise<UpID>

name()​

name(): Promise<string>

Return the fully qualified name of the service

Returns​

Promise<string>

originalModule()​

originalModule(): Module_

The original module in which the service has been defined

Returns​

Module_

path()​

path(): Promise<string[]>

The path of the service within its module

Returns​

Promise<string[]>

run()​

run(): Up

Execute the service function

Returns​

Up

with()​

with(arg): Up

Call the provided function with current Up.

This is useful for reusability and readability by not breaking the calling chain.

Parameters​

arg​

(param) => Up

Returns​

Up