StringTransformer

String transformer transforms a string based on the given parameters.

If no parameters are given, the string will be returned as is. If an integer parameter is given, the string will be split into an array of strings using payload or space as a separator, and will return the element at the given index (integer parameter).

Use a + before the index to reference every element up to and including the index value.

Use a + after the index to reference the index value and every element after it.

Usage

import { Interpreter, StringTransformer, StrictVarsParser } from 'tagscript';
const ts = new Interpreter(new StrictVarsParser());

const { Interpreter, StringTransformer, StrictVarsParser } = require('tagscript');
const ts = new Interpreter(new StrictVarsParser());

API

Check StringTransformer for the API documentation.

For End Users

{variable}
{variable(index)}
{variable(+index)}
{variable(index+)}
{variable.index:separator}

# Basic usage
{args}
# Hi, How are you?

# Get specific index (1-based)
{args(1)}
# Hi,

{args(2)}
# How

# Get everything up to and including index
{args(+2)}
# Hi, How

{args(+3)}
# Hi, How are

# Get everything from index onwards
{args(2+)}
# How are you?

{args(3+)}
# are you?

# Using custom separator
{args.1:|}
# If args contains "apple|banana|cherry"
# apple

{args.2+:|}
# banana|cherry