Class SyncRecordsExperimental

Readonly Experimentalenabled

Readonly Experimentalfile

size

• get size(): number
  Experimental

  How many files have a record.

  Returns number

checkpoint

• checkpoint(): Promise<void>
  Experimental

  Saves when 50 changes or 5 seconds have gone by since the last save.

  Returns Promise<void>

delete

• delete(target: string): void
  Experimental

  Forgets the record of a path, as when it is gone on both sides.

  Parameters

  • target: string

  Returns void

get

• get(target: string): SyncRecord | undefined
  Experimental

  The record of a site-relative path, if it has one.

  Parameters

  • target: string

  Returns SyncRecord | undefined

lastSyncedAt

• lastSyncedAt(): number | undefined
  Experimental

  The most recent sync time of any file, or undefined.

  Returns number | undefined

paths

• paths(): string[]
  Experimental

  Every path with a record.

  Returns string[]

reset

• reset(): Promise<void>
  Experimental

  Forgets every record and removes the file.

  Returns Promise<void>

save

• save(): Promise<void>
  Experimental

  Writes the records atomically under a lock, when anything changed since the last save.

  Returns Promise<void>

set

• set(target: string, record: SyncRecord): void
  Experimental

  Records both sides of a path as just synchronized. Ignored when the records are disabled.

  Parameters

  • target: string
  • record: SyncRecord

  Returns void

Staticload

• load(
      stateDir: string,
      siteId: string,
      serverId: string,
      enabled: boolean,
  ): Promise<SyncRecords>
  Experimental

  Reads the records of a site and server, or starts empty when there are none yet.

  Parameters

  • stateDir: string
  • siteId: string
  • serverId: string
  • enabled: boolean

  Returns Promise<SyncRecords>

  Throws

  SyncError E_CONFIG_INVALID when the file is damaged.