Interface: NodeSpaces

Defined in: packages/core/src/node/types.ts:481

MethodsCopy Anchor Link

access()Copy Anchor Link

access(spaceId): Promise<SpaceAccess>;

Defined in: packages/core/src/node/types.ts:494

Roles, members and invites, as the space's access history says now

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceAccess>

assign()Copy Anchor Link

assign(
   spaceId, 
   did, 
   role
): Promise<void>;

Defined in: packages/core/src/node/types.ts:507

Assigns a role to an account. Needs /role/assign

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

authenticator()Copy Anchor Link

authenticator(spaceId): Promise<ServerAuth | null>;

Defined in: packages/core/src/node/types.ts:547

How a node serving this space checks connecting peers and signs its welcome; null for a space it does not hold

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<ServerAuth | null>

carried()Copy Anchor Link

carried(spaceId, options?): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:535

Waits up to waitMs (default 3 s) for a connected carrier to hold all this node does of a space

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

changeKey()Copy Anchor Link

changeKey(spaceId): Promise<void>;

Defined in: packages/core/src/node/types.ts:519

Gives a private space a new key, for a lost device. Needs /key/change

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

closeInvite()Copy Anchor Link

closeInvite(spaceId, keyOrLink): Promise<void>;

Defined in: packages/core/src/node/types.ts:517

Closes an invite, by link or by its key from access().invites. Who joined with it stays.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

create()Copy Anchor Link

create(params): Promise<SpaceSummary>;

Defined in: packages/core/src/node/types.ts:484

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceSummary>

defineRole()Copy Anchor Link

defineRole(spaceId, role): Promise<void>;

Defined in: packages/core/src/node/types.ts:505

Writes a role's definition, replacing the ones held. Needs /role/define

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

get()Copy Anchor Link

get(spaceId): Promise<SpaceSummary | null>;

Defined in: packages/core/src/node/types.ts:483

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceSummary | null>

hold()Copy Anchor Link

hold(spaceId): Promise<() => Promise<void>>;

Defined in: packages/core/src/node/types.ts:530

Keeps a space syncing until the function it returns is called; it stops once nothing holds it

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<() => Promise<void>>

holdsRole()Copy Anchor Link

holdsRole(
   spaceId, 
   role, 
   account?
): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:503

Whether this account, or account, holds every grant of a role at least as wide; may say no wrongly, never yes

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

invite()Copy Anchor Link

invite(spaceId, options?): Promise<string>;

Defined in: packages/core/src/node/types.ts:486

An invite string. For a private space it carries the key: treat it as a secret

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<string>

join()Copy Anchor Link

join(invite, options?): Promise<SpaceSummary>;

Defined in: packages/core/src/node/types.ts:490

Joins a space from an invite. memberKey lets a node without the account key receive new space keys

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceSummary>

kept()Copy Anchor Link

kept(
   spaceId, 
   waitMs, 
   since?
): Promise<"keepers" | "peer" | null>;

Defined in: packages/core/src/node/types.ts:545

Waits up to waitMs (at most a minute) for this node's writes in a space to be kept elsewhere: by the space's keepers, every write from since (ms) on, all by default ('keepers'); or, in a space that names none, where every member's node is a copy, by a peer connected now that holds all this node does ('peer'). Null when nobody had, in time.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<"keepers" | "peer" | null>

leave()Copy Anchor Link

leave(spaceId): Promise<void>;

Defined in: packages/core/src/node/types.ts:492

Gives up the account's place in a space, then forgets it and its key here

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

list()Copy Anchor Link

list(): Promise<readonly SpaceSummary[]>;

Defined in: packages/core/src/node/types.ts:482

ReturnsCopy Anchor Link

Promise<readonly SpaceSummary[]>

may()Copy Anchor Link

may(
   spaceId, 
   cmd, 
   args?, 
   account?
): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:496

Whether this account, or account, may invoke a command with these arguments in a space now (spec 03 §2)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

preview()Copy Anchor Link

preview(invite): Promise<InvitePreview>;

Defined in: packages/core/src/node/types.ts:488

What an invite or link is for; a short link is fetched from its mailboxes first

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<InvitePreview>

profiles()Copy Anchor Link

profiles(spaceId): Promise<readonly SpaceProfile[]>;

Defined in: packages/core/src/node/types.ts:549

The name each person gave in this space; yours is published from the account's name

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<readonly SpaceProfile[]>

reached()Copy Anchor Link

reached(
   spaceId, 
   peer, 
   waitMs
): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:537

Waits up to waitMs (at most a minute) for one peer, by its key, to hold all this node does of a space; for a node about to close

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

removeMember()Copy Anchor Link

removeMember(spaceId, did): Promise<void>;

Defined in: packages/core/src/node/types.ts:511

Removes an account and its roles. Needs /member/remove, unless it is you

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

revoke()Copy Anchor Link

revoke(
   spaceId, 
   key, 
   options?
): Promise<boolean>;

Defined in: packages/core/src/node/types.ts:528

Revokes one of this account's keys, by DID: nothing it writes counts from then on. With waitMs, waits that long for a peer to take it in: true when one did, or with no wait.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<boolean>

send()Copy Anchor Link

send(
   spaceId, 
   message, 
   to?
): Promise<void>;

Defined in: packages/core/src/node/types.ts:532

A live message (at most 64 KB) to peers connected now, to an account or a session DID; kept nowhere

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setKeepers()Copy Anchor Link

setKeepers(
   spaceId, 
   keepers, 
   copies?
): Promise<void>;

Defined in: packages/core/src/node/types.ts:523

Names the nodes that keep the space whole (at most 16), and how many a write should reach. Needs /space/keepers

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

setRelays()Copy Anchor Link

setRelays(spaceId, relays): Promise<void>;

Defined in: packages/core/src/node/types.ts:521

Names the relays (wss://, at most 8) the space's members meet on. Needs /space/relays

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

status()Copy Anchor Link

status(spaceId): Promise<SpaceStatus>;

Defined in: packages/core/src/node/types.ts:533

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<SpaceStatus>

stepDown()Copy Anchor Link

stepDown(spaceId, options?): Promise<void>;

Defined in: packages/core/src/node/types.ts:513

Stops being a founder but stays, taking role keep first when given

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

succeed()Copy Anchor Link

succeed(spaceId, successor): Promise<void>;

Defined in: packages/core/src/node/types.ts:515

Names a space that succeeds this one. Needs /space/succeed, or a place here when no one holds it

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>

unassign()Copy Anchor Link

unassign(
   spaceId, 
   did, 
   role
): Promise<void>;

Defined in: packages/core/src/node/types.ts:509

Takes a role from an account. Needs /role/unassign, unless it is your own

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Promise<void>