ApiCoreInterfaces
Interface: HostDescription
Defined in: packages/core/src/session/hosting.ts:286
What a host says about itself, to anyone, at /.well-known/minca-host.
Its fund says how money goes in; how a payment is taken is the host's own.
Properties
| Property | Modifier | Type | Description | Defined in |
|---|---|---|---|---|
bots? | readonly | boolean | Whether it runs bots for the spaces it carries (startBot), from their fund | packages/core/src/session/hosting.ts:302 |
connectors? | readonly | readonly HostConnectorOffer[] | The services its bots can be connected to, at /host/bots/<bot>/connect/<id> (spec 08 §3.1) | packages/core/src/session/hosting.ts:306 |
did | readonly | string | Its own key, as it appears to peers, and what signs its statuses | packages/core/src/session/hosting.ts:289 |
free | readonly | boolean | Every subscription counts as paid — someone hosting themselves | packages/core/src/session/hosting.ts:292 |
fund? | readonly | FundOffer | How money goes in here: an account's balance, and a community's fund anyone adds to. Absent: it takes no payments. | packages/core/src/session/hosting.ts:304 |
limits? | readonly | HostLimits | What it keeps for free, what paying adds, and where a community has to pay for itself (spec 08 §1.1) | packages/core/src/session/hosting.ts:308 |
minca | readonly | "host/1" | - | packages/core/src/session/hosting.ts:287 |
name | readonly | string | - | packages/core/src/session/hosting.ts:290 |
peer? | readonly | string | Where it takes peers: a WebSocket address, relative to the host's address or absolute | packages/core/src/session/hosting.ts:298 |
price? | readonly | string | For people, as the host puts it: "$4 a month or $36 a year" | packages/core/src/session/hosting.ts:294 |
remind? | readonly | boolean | Whether it sends reminders by email before paid time runs out, to an address given with remind | packages/core/src/session/hosting.ts:300 |
terms? | readonly | string | Its terms, for people | packages/core/src/session/hosting.ts:296 |