@zturnlibs/ztron-api

---

localhost#

Interfaces#

LocalhostStatus#

Defined in: localhost.ts:4

Properties#

already?#

optional already?: boolean

Defined in: localhost.ts:5

origin?#

optional origin?: string

Defined in: localhost.ts:8

port#

port: number | null

Defined in: localhost.ts:7

running?#

optional running?: boolean

Defined in: localhost.ts:6

stopped?#

optional stopped?: boolean

Defined in: localhost.ts:9

Variables#

localhost#

const localhost: object

Defined in: localhost.ts:27

Type Declaration#

start#

start: (port?) => Promise<LocalhostStatus>

Starts (or reports) the localhost asset origin.

Parameters#

port?#

number

Returns#

Promise<LocalhostStatus>

status#

status: () => Promise<LocalhostStatus>

Current origin status.

Returns#

Promise<LocalhostStatus>

stop#

stop: () => Promise<LocalhostStatus>

Stops the origin.

Returns#

Promise<LocalhostStatus>

Functions#

start()#

start(port?): Promise<LocalhostStatus>

Defined in: localhost.ts:13

Starts (or reports) the localhost asset origin.

Parameters#

port?#

number

Returns#

Promise<LocalhostStatus>

---

status()#

status(): Promise<LocalhostStatus>

Defined in: localhost.ts:23

Current origin status.

Returns#

Promise<LocalhostStatus>

---

stop()#

stop(): Promise<LocalhostStatus>

Defined in: localhost.ts:18

Stops the origin.

Returns#

Promise<LocalhostStatus>