Interface: NodeCarriers
Defined in: packages/core/src/node/types.ts:664
Nodes that keep the account's spaces online without reading them (space/pass.ts). Needs the account key
Methods
add()
add(carrier): Promise<{
invite: string;
space: string;
}>;Defined in: packages/core/src/node/types.ts:667
Starts using a carrier: a carry space with a pass for every space, and the invite to give it
Parameters
| Parameter | Type |
|---|---|
carrier | { did: string; name: string; } |
carrier.did | string |
carrier.name | string |
Returns
Promise<{
invite: string;
space: string;
}>
list()
list(): Promise<readonly CarrierSummary[]>;Defined in: packages/core/src/node/types.ts:665
Returns
Promise<readonly CarrierSummary[]>
reached()
reached(space, waitMs): Promise<boolean>;Defined in: packages/core/src/node/types.ts:672
Waits up to waitMs for the carrier to hold what this node wrote for it; for a node about to close
Parameters
| Parameter | Type |
|---|---|
space | string |
waitMs | number |
Returns
Promise<boolean>
remove()
remove(space): Promise<void>;Defined in: packages/core/src/node/types.ts:676
Stops using a carrier: its passes go, and it is told to forget what it held
Parameters
| Parameter | Type |
|---|---|
space | string |
Returns
Promise<void>
settled()
settled(waitMs): Promise<boolean>;Defined in: packages/core/src/node/types.ts:674
Waits up to waitMs for the passes and wakes written in the background to be done; for a node about to close
Parameters
| Parameter | Type |
|---|---|
waitMs | number |
Returns
Promise<boolean>