Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncPlugin

Hierarchy

  • SyncPlugin

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

editron

editron: default

hooks

hooks: {} = ...

Type declaration

id

id: string = "sync-plugin"

Methods

copyData

  • copyData(pointer: string, syncOptions: { addToHistory?: boolean; mappingFromTo: {} }, previous: any): void

  • Parameters

    • pointer: string
    • syncOptions: { addToHistory?: boolean; mappingFromTo: {} }
      • Optional addToHistory?: boolean

        if true, will add updates to undo history. Defaults to false

      • mappingFromTo: {}

        map of relative json-pointer from source to target

    • previous: any

    Returns void

initialize

  • initialize(editron: default): void

onModifiedData

startSync

  • startSync(pointer: any, options: { addToHistory?: boolean; mappingFromTo: {} }): void

  • Parameters

    • pointer: any
    • options: { addToHistory?: boolean; mappingFromTo: {} }
      • Optional addToHistory?: boolean

        if true, will add updates to undo history. Defaults to false

      • mappingFromTo: {}

        map of relative json-pointer from source to target

    Returns void

stopSync

  • stopSync(pointer: any): void

Generated using TypeDoc