Basic Examples

This page demonstrates basic usage of FuncyStr with code examples. You can also test the functionality through the interactive demo page.

(dynamic demo)[].

Basic string processing

Instantiating the library with base functions, you can use those to process functions within the text. All functions given to FuncyStr must include params as the first parameter, even if they don't use it.

INFO

As of funcystr v2.0, the result of the process operation is now a Promise that resolves into the processed string. This allows the use of advanced async functions.

  const funcyStr = new FuncyStr({
    uppercase: (params, str) => str.toUpperCase(),
    repeat: (params, str, times) => str.repeat(Number(times)),
  });

We can process strings directly, without needing external parameters.

  result = await funcyStr.process(
    "{{uppercase|this}} is a demo that is {{repeat|really |3}} simple."
  )

> THIS is a demo that is really really really simple.

Providing parameters

Parameters can be given by the general application to set the values within given functions by the context. This can be used to dynamically change the processed values depending on some external choices given to users or within the application.

One example for this is allowing the user to choose variables that will change the string processing, like in the example below. You can see how changing the values in the inputs changes the result:

const funcyStr = new FuncyStr({
  // {{charname}} --> params.name
  charname: (params) => params.name,
  pronoun: (params, he, she, they) => {
    return params.pronoun === 'he' ?
      he : params.pronoun === 'she' ?
      she : they;
  }
});

The result of processing strings given the above functions depend on the values of the parameters:

  result = await funcyStr.process(
    '{{charname}} went to the store and bought \
    {{pronoun|himself|herself|themselves}} the groceries \
    {{pronoun|he|she|they}} wanted most.',
    {
      name: `Sam`,
      pronoun: `they`
    }
  )

> Sam went to the store and bought themselves the groceries 
  they wanted most.

If we run this with different parameters, the output will change accordingly:

  result = await funcyStr.process(
    '{{charname}} went to the store and bought \
    {{pronoun|himself|herself|themselves}} the groceries \
    {{pronoun|he|she|they}} wanted most.',
    {
      name: `Max`,
      pronoun: `she`
    }
  )

> Max went to the store and bought herself the groceries 
  she wanted most.