bob6664569 / content-spinner

Tiny Node.js package to spin string content

content-spinner

Node.js recursive content spinner algorithm with available predictable behavior.

Based on string-content-spinner (@heek)

Install

npm i content-spinner

API

The spin function

Spin a string.

Parameters:

spin(stringToSpin: string[, seed: string]);

Example without seed parameter:

const spin = require('content-spinner');

const result = spin('{Hello|Good morning} world');

console.log(result);

This will log either Hello world or Good morning world.

Example with a seed parameter:

const spin = require('content-spinner');

const result = spin('{Hello|Good morning} world', 'Random text');

console.log(result);

This example will always product the same output with the same string passed as the second parameter.

The factory function

Generates a new spin function with custom section markers and delimiter.

Parameters:

factory(openSectionMarker: string, closeSectionMarker: string, delimiter: string);

Example:

// Get factory function
const spinFactory = require('content-spinner').factory;

// Generate new spin function with custom section markers and delimiter
const spin = spinFactory('[[', ']]', '::');

// Use it!
const result = spin('Hello [[world::mars]]');

console.log(result);

This will log either Hello world or Hello mars.

Development

NPM commands

• npm run prettier: run prettier on source files (both lib and test files)
• npm run lint: lint source files (both lib and test files, using eslint)
• npm test or npm run test: run unit tests
• npm run git-add: run prettor, lint and unit tests, if all passed, stage changes