API reference

Every public function with its arguments, return values and a short example.

Renders a record using a template string with named placeholders.

const { formatRecord } = require("stackwise");

const result = formatRecord(data, { strict: true });
console.log(result);

Creates a store from the given options and returns an object with read and write methods.

const { createStore } = require("stackwise");

const result = createStore(config, { strict: true });
console.log(result);

Validates a value against a schema and returns the cleaned result or a list of errors.

const { parseInput } = require("stackwise");

const result = parseInput(data, { strict: true });
console.log(result);

Combines two configuration objects, giving priority to the second and keeping types intact.

const { mergeConfig } = require("stackwise");

const result = mergeConfig(config, { strict: true });
console.log(result);

Runs an asynchronous task again if it fails, with a short delay between attempts.

const { retryTask } = require("stackwise");

const result = retryTask(items, { strict: true });
console.log(result);

Splits a list into groups of the given size and processes them in order.

const { batchUpdate } = require("stackwise");

const result = batchUpdate(data, { strict: true });
console.log(result);

Converts the current state to a compact string that can be restored later.

const { serializeState } = require("stackwise");

const result = serializeState(config, { strict: true });
console.log(result);

Calls the handler every time the target changes and returns a function to stop watching.

const { watchChanges } = require("stackwise");

const result = watchChanges(items, { strict: true });
console.log(result);