Line

You are reading the unreleased docs (next). See latest (v0.9)

ui/server/src/unitsApi

Thin REST adapter over src/engine/unitSummary.mjs (deterministic unit summaries for bots and the Cockpit).

Cockpit server, next. Source: ui/server/src/unitsApi.mjs.

Functions#

featuresIndex()#

featuresIndex(root): object

Defined in: ui/server/src/unitsApi.mjs:21

Parameters#

root

any

Returns#

object

body

body: any = result

status

status: any


featureSummary()#

featureSummary(root, name, q?): object

Defined in: ui/server/src/unitsApi.mjs:22

Parameters#

root

any

name

any

q?

Returns#

object

body

body: any = result

status

status: any


unitsIndex()#

unitsIndex(root, q?): object

Defined in: ui/server/src/unitsApi.mjs:19

Parameters#

root

any

q?

Returns#

object

body

body: any

status

status: number


unitSummary()#

unitSummary(root, q?): object

Defined in: ui/server/src/unitsApi.mjs:20

Parameters#

root

any

q?

Returns#

object

body

body: any = result

status

status: any