Single-market-robot-simulator-openzip NPM

single-market-robot-simulator-openzip

Returns a Promise yielding restored simulation data from a zip file. The returned data has single-market-robot-simulator simulations in data.sims and configuration data in data.config.

Used by single-market-robot-simulator-app-framework

Installation

npm i single-market-robot-simulator-openzip -S

Usage

This module exports a single function, openzip.

import

import openzip from 'single-market-robot-simulator-openzip';

Calling

 const data = await openZip(zipdata, SMRS, progress);

returns a Promise resolving to properties data.sims and data.config

Parameters

zipdata is a Blob or ArrayBuffer to be read by Greggman and Trevor Sanz's unzippit module

SMRS is an object containing an import of single-market-robot-simulator or similar code

progress, optional, is a function taking a single object parameter {value, max, message} that writes status updates to an appropriate part of the screen