object-string-replacer v1.1.0

object-string-replacer

No need for a massive template libraries anymore, this is less than < 9kb with 0 dependencies!

Here's a set of functions for manipulating strings and objects, in a simple effective way; for use with templating, strings from the DB etc.. It includes functionality for extracting keys from a string, getting values from a complex object using a path, and replacing tokens in a string using data from an object.

The package also provides options for using fallback values in case the desired keys are missing. These functions make it easy to work with templates and dynamic data, and are useful in a variety of applications such as generating dynamic content, creating reports, and more.

Installation

You can install the "object-string-replacer" package from npm by running the following command:

npm install object-string-replacer

Once the package is installed, you can use it in your code by importing it:

import { getValueFromPath, replaceTokens, extractKeys } from 'object-string-replacer';

Extracting Keys, Getting Values, and Replacing Tokens

This is a set of functions for extracting keys from a string, getting values from a complex object using a path, and replacing tokens in a string using data from an object.

Replacing Tokens in a String using Data from an Object

This function takes a string and an object and replaces the tokens in the string with the values from the object.

Example:

const templateString = 'Hello {{person.name}}, you live at {{person.address.street}}, {{person.address.city}}, {{person.address.state}}.';
console.log(replaceTokens(templateString, data));

Output: 'Hello John Doe, you live at 123 Main St, Anytown, NY.'

Using Fallback Tokens for Missing Keys with || or Option

This function takes a string, an object, and a fallback object and replaces the tokens in the string with the values from the object. If the token is not found in the object, it will use the value from the fallback object.

Example:

const str = 'Hello {{fullName || friend}}. How are you today?';
const tokens = { name: 'John' };
const fallbackTokens = { friend: 'Jane' };

console.log(replaceTokens(str, tokens, fallbackTokens));

Output: "Hello Jane. How are you today?"

Extracting Keys from a String

This function takes a string and extracts the keys from it.

Example:

const inputString = 'This is a {{template}} string with {{keys}} that need to be {{replaced}}.';
console.log(extractKeys(inputString));

Output: ['template', 'keys', 'replaced']

Getting Value from a Complex Object using a Path

This function takes an object and a path and returns the value from the object at the specified path.

Example:

const data = {
    person: {
        name: 'John Doe',
        age: 30,
        address: {
            street: '123 Main St',
            city: 'Anytown',
            state: 'NY',
        },
    },
    colors: ['red', 'green', 'blue'],
};
console.log(getValueFromPath('person.name', data));

Output: 'John Doe'

console.log(getValueFromPath('colors[1]', data));

Output: 'green'