Skip to content

Documentation / @super-line/server / ServerStoreHandle

Interface: ServerStoreHandle

Defined in: index.ts:225

Server-side handle for one configured Store, reached via srv.store.<name>. The server is authoritative: it creates Resources, grants/revokes access, and may co-write. data is untyped (stores are off-contract — see ADR-0003); callers assert the shape.

Methods

create()

create(id, data, accessRules): Promise<void>

Defined in: index.ts:227

Create a Resource with initial data + access rules (deny-by-default for everyone unlisted).

Parameters

id

string

data

unknown

accessRules

AccessRules

Returns

Promise<void>


delete()

delete(id): Promise<void>

Defined in: index.ts:237

Delete a Resource.

Parameters

id

string

Returns

Promise<void>


grant()

grant(id, principal, perms): Promise<void>

Defined in: index.ts:233

Grant a principal read/write on a Resource.

Parameters

id

string

principal

string

perms

Perms

Returns

Promise<void>


list()

list(): Promise<string[]>

Defined in: index.ts:239

All Resource ids in this store.

Returns

Promise<string[]>


read()

read(id): Promise<Resource<unknown> | undefined>

Defined in: index.ts:229

Read a Resource (data + accessRules), or undefined if absent.

Parameters

id

string

Returns

Promise<Resource<unknown> | undefined>


revoke()

revoke(id, principal): Promise<void>

Defined in: index.ts:235

Revoke a principal's access to a Resource entirely.

Parameters

id

string

principal

string

Returns

Promise<void>


write()

write(id, data): Promise<void>

Defined in: index.ts:231

Server co-write: replace the Resource's value (LWW), fanned out to subscribers with a server origin.

Parameters

id

string

data

unknown

Returns

Promise<void>

Released under the MIT License.