texting-squirrel v1.1.0

Texting Squirrel

Module to format texts with variables and functions. It supports multiple dictionaries.

Installation

$ npm install texting-squirrel

Usage

import Text from 'texting-squirrel';

console.log(Text.format('Hi, {0}!', 'developer')); // will output Hi, developer!

Text.addDictionary('test', { module_name: 'Texting Squirrel' });
Text.setDictionary('test');

console.log(Text.get('module_name')); // will output Texting Squirrel
console.log(Text.format('I am using {module_name} module')); // will output I am using Texting Squirrel

Text functions

Functions can be registered to the module. The texts can be updated with those funtions

count(index, a, b, c)

gender(index, a, b, c)

import Text from 'texting-squirrel';

console.log(Text.format('{count(0, script, scripts, scripts)}', 5)); // will output 5 scripts
console.log(Text.format('{gender(0, He, She, He/She)} codes', 'female')); // will output She codes

Custom functions

Custom fuctions can be registered and called

Text.addFunction('date', () => new Date().toISOString());
console.log(Text.format('{date()}')); // will output [actual date in iso format]

TODO

• passing JSON in the text -> every text in braces is cleared

Functions

addDictionary(key, dictionary) ⇒ Text

Adds the new dictionary.

Kind: global function Returns: Text - Instance of the Text class.

getDictionary(key) ⇒ Dictionary

Gets the dictionary by the key.

Kind: global function Returns: Dictionary - Dictionary instance or null.

setDictionary(key) ⇒ Text

Sets the actual dictionary.

Kind: global function Returns: Text - Instance of the Text class.

addFunction(name, fn) ⇒ Text

Adds the function.

Kind: global function Returns: Text - Instance of the Text class.

get(key, ...args) ⇒ string

Formats the text from the set dictionary. The text is searched as a value in the dictionary by defined key. If the key is not found in set dictionary it tries to find the text in default dictionary.

Kind: global function Returns: string - Formatted text.

format(text, ...args) ⇒ string

If there's a number in braces the value to replace is searched in the args by orIf it's a function in the braces the function is called. First parameter acceptsIt it's a string in the braces the value to replace is searched in the set dictionary.

Kind: global function Returns: string - Formatted text.

Example (Passing variables)

Text.format('{0}', 'one'); // returns one
Text.format('{0} {1} {2}', 'one', 'two', 'three'); // returns one two three

Example (Count function)

Text.format('{count(0, script, scripts, scripts)}', 5); // returns 5 scripts

Example (Gender function)

Text.format('{gender(0, He, She, He/She)} codes', 'female'); //returns She codes