Skip to main content

Class: Address

A standardized address to load containers, directories, secrets, and other object types. Address format depends on the type, and is validated at type selection.

Extends​

  • BaseClient

Constructors​

Constructor​

new Address(ctx?, _id?, _value?): Address

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

Parameters​

ctx?​

Context

_id?​

AddressID

_value?​

string

Returns​

Address

Overrides​

BaseClient.constructor

Methods​

container()​

container(): Container

Load a container from the address.

Returns​

Container

directory()​

directory(opts?): Directory

Load a directory from the address.

Parameters​

opts?​

AddressDirectoryOpts

Returns​

Directory

file()​

file(opts?): File

Load a file from the address.

Parameters​

opts?​

AddressFileOpts

Returns​

File

gitRef()​

gitRef(): GitRef

Load a git ref (branch, tag or commit) from the address.

Returns​

GitRef

gitRepository()​

gitRepository(): GitRepository

Load a git repository from the address.

Returns​

GitRepository

id()​

id(): Promise<AddressID>

A unique identifier for this Address.

Returns​

Promise<AddressID>

secret()​

secret(): Secret

Load a secret from the address.

Returns​

Secret

service()​

service(): Service

Load a service from the address.

Returns​

Service

socket()​

socket(): Socket

Load a local socket from the address.

Returns​

Socket

value()​

value(): Promise<string>

The address value

Returns​

Promise<string>