Guard / foldkit-guard/sync

GuardedDocument

interface · packages/guard/src/sync.ts:33

interface GuardedDocument<User> {
  readonly entity: AnyEntity
  readonly members: ReadonlyArray<string>
  readonly readers: ReadonlyArray<PrincipalGuard<User>>
}

A document of edits to an Entity's members, and who may open it.

Members

GuardedDocument.entity

property · packages/guard/src/sync.ts:34

readonly entity: AnyEntity

GuardedDocument.members

property · packages/guard/src/sync.ts:35

readonly members: ReadonlyArray<string>

GuardedDocument.readers

property · packages/guard/src/sync.ts:36

readonly readers: ReadonlyArray<PrincipalGuard<User>>