External module "exporters/zip"

createZipExporter

• createZipExporter(store: Store<ModelState>, library: object, onChange?: undefined | function): ZipExporter
• createZipExporter<T>(store: Store<T>, library: object, select: function, onChange?: undefined | function): ZipExporter

• Instantiates a zip-file exporter for the given store

  Parameters

  • store: Store<ModelState>

    The store to listen on and retrieve state from

  • library: object

    The map of utility files to include in the resulting zip, in addition to the state.json and thumbnail.svg

    • [index: string]: Buffer

  • Optional onChange: undefined | function

    The optional callback to execute whenever a state update is fired

  Returns ZipExporter

• Instantiates a zip-file exporter for the given store

  Type parameters

  • T

  Parameters

  • store: Store<T>

    The store to listen on and retrieve state from

  • library: object

    The map of utility files to include in the resulting zip, in addition to the state.json and thumbnail.svg

    • [index: string]: Buffer

  • select: function

    A function which, given a state of type T, selects the ModelState fragement of that state

    • • (state: T): ModelState

      • Parameters

        • state: T

        Returns ModelState

  • Optional onChange: undefined | function

    The optional callback to execute whenever a state update is fired

  Returns ZipExporter