Synclets logoSynclets

SyncletImplementations

The SyncletImplementations type.

{
  onStart?: () => Promise<void>;
  onStop?: () => Promise<void>;
  onSync?: (address: AnyAddress<Depth>) => Promise<void>;
  onSetAtom?: (address: AtomAddress<Depth>) => Promise<void>;
  getSendContext?: (receivedContext?: Context) => Promise<Context>;
  canReceiveMessage?: (context: Context) => Promise<boolean>;
  canReadAtom?: (address: AtomAddress<Depth>, context: Context) => Promise<boolean>;
  canWriteAtom?: (address: AtomAddress<Depth>, atom: Atom, context: Context) => Promise<boolean>;
  canRemoveAtom?: (address: AtomAddress<Depth>, context: Context) => Promise<boolean>;
  filterChildIds?: (address: AnyParentAddress<Depth>, childIds: string[], context: Context) => Promise<string[]>;
}
TypeDescription
onStart?() => Promise<void>
onStop?() => Promise<void>
onSync?(address: AnyAddress<Depth>) => Promise<void>
onSetAtom?(address: AtomAddress<Depth>) => Promise<void>
getSendContext?(receivedContext?: Context) => Promise<Context>
canReceiveMessage?(context: Context) => Promise<boolean>
canReadAtom?(address: AtomAddress<Depth>, context: Context) => Promise<boolean>
canWriteAtom?(address: AtomAddress<Depth>, atom: Atom, context: Context) => Promise<boolean>
canRemoveAtom?(address: AtomAddress<Depth>, context: Context) => Promise<boolean>
filterChildIds?(address: AnyParentAddress<Depth>, childIds: string[], context: Context) => Promise<string[]>

Since

v0.0.0