polotno-node 1.0.0 → 2.0.0

package/README.md

@@ -37,6 +37,33 @@ run();
 
 ## API
 
+### `createInstance(options)`
+
+Create working instance of Polotno Node.
+
+```js
+const { createInstance } = require('polotno-node');
+const instance = await createInstance({
+  // this is a demo key just for that project
+  // (!) please don't use it in your projects
+  // to create your own API key please go here: https://polotno.dev/cabinet
+  key: 'nFA5H9elEytDyPyvKL7T',
+  // useParallelPages - use parallel pages to speed up rendering
+  // you can use false only for sequential calls
+  // it may break rendering if you call many parallel requests
+  // default is true
+  useParallelPages: false,
+  // url - url of the Polotno Client Editor
+  // client editor is just simple public html page that have `store` as global variable
+  // by default it will run local build
+  url: 'https://yourappdomain.com/client',
+  // browser - puppeteer browser instance
+  // by default it will use chrome-aws-lambda
+  // useful to set your own rendering props or use browserless
+  browser: browser,
+});
+```
+
 ### `instance.jsonToDataURL(json, attrs)`
 
 Export json into data URL.
@@ -50,7 +77,10 @@ res.json({ url });
 
 // export many pages:
 for (const page of json.pages) {
-  const url = await instance.jsonToDataURL(json, { pageId: page.id });
+  const url = await instance.jsonToDataURL(
+    { ...json, pages: [page] }, // for optimization, we can modify JSON to include only one page
+    { pageId: page.id }
+  );
   // do something with url
 }
 ```
@@ -70,9 +100,10 @@ fs.writeFileSync('out.png', imageBase64, 'base64');
 
 // export many pages:
 for (const page of json.pages) {
-  const imageBase64 = await instance.jsonToImageBase64(json, {
-    pageId: page.id,
-  });
+  const imageBase64 = await instance.jsonToImageBase64(
+    { ...json, pages: [page] }, // for optimization, we can modify JSON to include only one page
+    { pageId: page.id }
+  );
   // do something with base64
 }
 ```