ApiCoreInterfaces
Interface: NodeCollections
Defined in: packages/core/src/node/types.ts:362
Methods
define()
define(spaceId, definition): Promise<NodeCollection>;Defined in: packages/core/src/node/types.ts:366
Publishes a definition into the space, as a signed record that syncs like any other
Parameters
| Parameter | Type |
|---|---|
spaceId | string |
definition | DefineCollection |
Returns
Promise<NodeCollection>
delete()
delete(spaceId, name): Promise<void>;Defined in: packages/core/src/node/types.ts:368
Takes a definition out of the space; refused while the collection still has records
Parameters
| Parameter | Type |
|---|---|
spaceId | string |
name | string |
Returns
Promise<void>
list()
list(spaceId): Promise<readonly NodeCollection[]>;Defined in: packages/core/src/node/types.ts:364
What a space holds: every defined collection, and every collection with records
Parameters
| Parameter | Type |
|---|---|
spaceId | string |
Returns
Promise<readonly NodeCollection[]>
tag()
tag(
spaceId,
collection,
field,
value
): Promise<string>;Defined in: packages/core/src/node/types.ts:370
The topic tag a record with this value carries; keyed in a private space, so only members can work it out
Parameters
| Parameter | Type |
|---|---|
spaceId | string |
collection | string |
field | string |
value | string | number | boolean |
Returns
Promise<string>