@kubric/editable-entity-processors

Table of Contents

• Installation
• Usage
• References
• Build
• Tests

Installation

Ensure you have Node.js 10 or later installed. Then run the following:

# via npm
npm install @kubric/editable-entity-processors

# or yarn
yarn add @kubric/editable-entity-processors

Usage

import parameterProcessor, {ENTITY} from '@kubric/editable-entity-processors';

const definedParams = {
  // custom params
}

const {parameters, features} = parameterProcessor(definedParams, {
  [ENTITY.PRODUCT_IMAGE_ENTITY]: 'https://some.url',
  [ENTITY.IMAGE_HEIGHT_ENTITY]: 100,
  [ENTITY.IMAGE_WIDTH_ENTITY]: 100,
  [ENTITY.QUALITY_ENTITY]: 'preview',
  [ENTITY.ISLANDSCAPE_ENTITY]: 1,
});

References

https://kubric.slite.com/api/s/note/E68noyDw4HREMQpR9pWpAM/Sticker-shot-config

Build

npm run build will build the library

Tests

npm test will run the tests and print the results