Class SvSync

Readonlydescribe

ReadonlysyncPrefix

currentStateVector

• get currentStateVector(): StateVector

  Obtain a copy of own state vector.

  Returns StateVector

  Remarks

  This may be used as SvSync.Options.initialStateVector to re-create an SvSync instance.

add

• add(name: NameLike): SyncNode<SvSync.ID>

  Retrieve or create sync node by name.

  For SVS v2, same as get(name).

  For SVS v3, create sync node with specified name and current bootstrap time. Note the different between get(name) and add(name):

  • get(name) searches for existing sync nodes with specified name first.
  • add(name) almost always creates a new sync node.

  Parameters

  • name: NameLike

  Returns SyncNode<SvSync.ID>

• add(id: { boot: number; name: NameLike }): SyncNode<SvSync.ID>

  Same as get(id) (SVS v3).

  Parameters

  • id: { boot: number; name: NameLike }

  Returns SyncNode<SvSync.ID>

• add(name: NameLike, boot: number): SyncNode<SvSync.ID>

  Same as get(name, boot) (SVS v3).

  Parameters

  • name: NameLike
  • boot: number

  Returns SyncNode<SvSync.ID>

close

• close(): void

  Cease operations.

  Returns void

get

• get(name: NameLike): SyncNode<SvSync.ID>

  Retrieve or create sync node by name.

  For SVS v2, retrieve or create sync node with specified name.

  For SVS v3, retrieve sync node with specified name and most recent bootstrap time. If no sync node with this name exists, create sync node with current time as bootstrap time.

  Parameters

  • name: NameLike

  Returns SyncNode<SvSync.ID>

• get(id: { boot: number; name: NameLike }): SyncNode<SvSync.ID>

  Retrieve or create sync node by name and bootstrap time (SVS v3).

  Parameters

  • id: { boot: number; name: NameLike }

  Returns SyncNode<SvSync.ID>

• get(name: NameLike, boot: number): SyncNode<SvSync.ID>

  Retrieve or create sync node by name and bootstrap time (SVS v3).

  Parameters

  • name: NameLike
  • boot: number

  Returns SyncNode<SvSync.ID>

Staticcreate

• create(__namedParameters: SvSync.Options): Promise<SvSync>

  Parameters

  • __namedParameters: SvSync.Options

  Returns Promise<SvSync>