@budibase/string-templates 2.22.1 → 2.22.3

package/dist/index.d.ts

@@ -1,20 +1,1078 @@
-export function processObject(object: object | any[], context: object, opts?: object | undefined): Promise<object | any[]>;
-export function processString(string: string, context: object, opts?: object | undefined): Promise<string>;
-export function processObjectSync(object: object | any[], context: object, opts?: object | undefined): object | any[];
-export function processStringSync(string: string, context: object, opts?: object | undefined): string;
-export function disableEscaping(string: any): any;
-export function makePropSafe(property: string): string;
-export function isValid(string: any, opts?: any): boolean;
-export function getManifest(): any;
-export function isJSBinding(handlebars: any): boolean;
-export function encodeJSBinding(javascript: any): string;
-export function decodeJSBinding(handlebars: any): string | null;
-export function doesContainStrings(template: string, strings: string[]): boolean;
-export function findHBSBlocks(string: string): string[];
-export function doesContainString(template: string, string: string): boolean;
-export function convertToJS(hbs: any): string;
-import { FIND_ANY_HBS_REGEX } from "./utilities";
-import { helpersToRemoveForJs } from "./helpers/list";
-export function defaultJSSetup(): void;
-import { iifeWrapper } from "./iife";
-export { setJSRunner, setOnErrorLog, FIND_ANY_HBS_REGEX, JsErrorTimeout, helpersToRemoveForJs, iifeWrapper };
+import { ProcessOptions } from "./types";
+export { setJSRunner, setOnErrorLog } from "./helpers/javascript";
+export { iifeWrapper } from "./iife";
+/**
+ * Given an input object this will recurse through all props to try and update any handlebars statements within.
+ * @param {object|array} object The input structure which is to be recursed, it is important to note that
+ * if the structure contains any cycles then this will fail.
+ * @param {object} context The context that handlebars should fill data from.
+ * @param {object|undefined} [opts] optional - specify some options for processing.
+ * @returns {Promise<object|array>} The structure input, as fully updated as possible.
+ */
+export declare function processObject<T extends Record<string, any>>(object: T, context: object, opts?: {
+    noHelpers?: boolean;
+    escapeNewlines?: boolean;
+    onlyFound?: boolean;
+}): Promise<T>;
+/**
+ * This will process a single handlebars containing string. If the string passed in has no valid handlebars statements
+ * then nothing will occur.
+ * @param {string} string The template string which is the filled from the context object.
+ * @param {object} context An object of information which will be used to enrich the string.
+ * @param {object|undefined} [opts] optional - specify some options for processing.
+ * @returns {Promise<string>} The enriched string, all templates should have been replaced if they can be.
+ */
+export declare function processString(string: string, context: object, opts?: ProcessOptions): Promise<string>;
+/**
+ * Given an input object this will recurse through all props to try and update any handlebars statements within. This is
+ * a pure sync call and therefore does not have the full functionality of the async call.
+ * @param {object|array} object The input structure which is to be recursed, it is important to note that
+ * if the structure contains any cycles then this will fail.
+ * @param {object} context The context that handlebars should fill data from.
+ * @param {object|undefined} [opts] optional - specify some options for processing.
+ * @returns {object|array} The structure input, as fully updated as possible.
+ */
+export declare function processObjectSync(object: {
+    [x: string]: any;
+}, context: any, opts: any): object | Array<any>;
+/**
+ * This will process a single handlebars containing string. If the string passed in has no valid handlebars statements
+ * then nothing will occur. This is a pure sync call and therefore does not have the full functionality of the async call.
+ * @param {string} string The template string which is the filled from the context object.
+ * @param {object} context An object of information which will be used to enrich the string.
+ * @param {object|undefined} [opts] optional - specify some options for processing.
+ * @returns {string} The enriched string, all templates should have been replaced if they can be.
+ */
+export declare function processStringSync(string: string, context?: object, opts?: ProcessOptions): string;
+/**
+ * By default with expressions like {{ name }} handlebars will escape various
+ * characters, which can be problematic. To fix this we use the syntax {{{ name }}},
+ * this function will find any double braces and switch to triple.
+ * @param string the string to have double HBS statements converted to triple.
+ */
+export declare function disableEscaping(string: string): string;
+/**
+ * Simple utility function which makes sure that a templating property has been wrapped in literal specifiers correctly.
+ * @param {string} property The property which is to be wrapped.
+ * @returns {string} The wrapped property ready to be added to a templating string.
+ */
+export declare function makePropSafe(property: any): string;
+/**
+ * Checks whether or not a template string contains totally valid syntax (simply tries running it)
+ * @param string The string to test for valid syntax - this may contain no templates and will be considered valid.
+ * @param [opts] optional - specify some options for processing.
+ * @returns {boolean} Whether or not the input string is valid.
+ */
+export declare function isValid(string: any, opts?: any): boolean;
+/**
+ * We have generated a static manifest file from the helpers that this string templating package makes use of.
+ * This manifest provides information about each of the helpers and how it can be used.
+ * @returns The manifest JSON which has been generated from the helpers.
+ */
+export declare function getManifest(): {
+    math: {
+        abs: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        add: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        avg: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        ceil: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        divide: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        floor: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        minus: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        modulo: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        multiply: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        plus: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        random: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        remainder: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        round: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        subtract: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        /**
+         * This will process a single handlebars containing string. If the string passed in has no valid handlebars statements
+         * then nothing will occur.
+         * @param {string} string The template string which is the filled from the context object.
+         * @param {object} context An object of information which will be used to enrich the string.
+         * @param {object|undefined} [opts] optional - specify some options for processing.
+         * @returns {Promise<string>} The enriched string, all templates should have been replaced if they can be.
+         */
+        sum: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    array: {
+        after: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        arrayify: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        before: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        eachIndex: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        filter: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        first: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        forEach: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        inArray: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isArray: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        itemAt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        join: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        equalsLength: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        last: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        length: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        lengthEqual: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        map: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        pluck: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        reverse: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        some: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        sort: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        sortBy: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withAfter: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withBefore: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withFirst: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withGroup: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withLast: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        withSort: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unique: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    number: {
+        bytes: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        addCommas: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        phoneNumber: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toAbbr: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toExponential: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toFixed: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toFloat: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toInt: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toPrecision: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    url: {
+        encodeURI: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        escape: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        decodeURI: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        urlResolve: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        urlParse: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        stripQuerystring: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        stripProtocol: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    string: {
+        append: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        camelcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        capitalize: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        capitalizeAll: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        center: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        chop: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        dashcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        dotcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        downcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        ellipsis: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        hyphenate: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isString: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        lowercase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        occurrences: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        pascalcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        pathcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        plusify: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        prepend: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        remove: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        removeFirst: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        replace: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        replaceFirst: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        sentence: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        snakecase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        split: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        startsWith: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        titleize: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        trim: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        trimLeft: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        trimRight: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        truncate: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        truncateWords: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        upcase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        uppercase: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    comparison: {
+        and: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        compare: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        contains: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        default: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        eq: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        gt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        gte: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        has: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isFalsey: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isTruthy: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        ifEven: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        ifNth: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        ifOdd: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        is: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isnt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        lt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        lte: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        neither: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        not: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        or: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unlessEq: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unlessGt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unlessLt: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unlessGteq: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+        unlessLteq: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    object: {
+        extend: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        forIn: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        forOwn: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        toPath: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        get: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        getObject: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        hasOwn: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        isObject: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        JSONparse: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        JSONstringify: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        merge: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        parseJSON: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        pick: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+        stringify: {
+            args: string[];
+            numArgs: number;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    uuid: {
+        uuid: {
+            args: any[];
+            numArgs: number;
+            example: string;
+            description: string;
+            requiresBlock: boolean;
+        };
+    };
+    date: {
+        date: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+        };
+        duration: {
+            args: string[];
+            numArgs: number;
+            example: string;
+            description: string;
+        };
+    };
+};
+/**
+ * Checks if a HBS expression is a valid JS HBS expression
+ * @param handlebars the HBS expression to check
+ * @returns {boolean} whether the expression is JS or not
+ */
+export declare function isJSBinding(handlebars: any): boolean;
+/**
+ * Encodes a raw JS string as a JS HBS expression
+ * @param javascript the JS code to encode
+ * @returns {string} the JS HBS expression
+ */
+export declare function encodeJSBinding(javascript: string): string;
+/**
+ * Decodes a JS HBS expression to the raw JS code
+ * @param handlebars the JS HBS expression
+ * @returns {string|null} the raw JS code
+ */
+export declare function decodeJSBinding(handlebars: string): string | null;
+/**
+ * Same as the doesContainString function, but will check for all the strings
+ * before confirming it contains.
+ * @param {string} template The template string to search.
+ * @param {string[]} strings The strings to look for.
+ * @returns {boolean} Will return true if all strings found in HBS statement.
+ */
+export declare function doesContainStrings(template: string, strings: any[]): boolean;
+/**
+ * Given a string, this will return any {{ binding }} or {{{ binding }}} type
+ * statements.
+ * @param {string} string The string to search within.
+ * @return {string[]} The found HBS blocks.
+ */
+export declare function findHBSBlocks(string: string): string[];
+/**
+ * This function looks in the supplied template for handlebars instances, if they contain
+ * JS the JS will be decoded and then the supplied string will be looked for. For example
+ * if the template "Hello, your name is {{ related }}" this function would return that true
+ * for the string "related" but not for "name" as it is not within the handlebars statement.
+ * @param {string} template A template string to search for handlebars instances.
+ * @param {string} string The word or sentence to search for.
+ * @returns {boolean} The this return true if the string is found, false if not.
+ */
+export declare function doesContainString(template: any, string: any): boolean;
+export declare function convertToJS(hbs: string): string;
+declare const _FIND_ANY_HBS_REGEX: RegExp;
+export { _FIND_ANY_HBS_REGEX as FIND_ANY_HBS_REGEX };
+export { JsErrorTimeout } from "./errors";
+declare const _helpersToRemoveForJs: string[];
+export { _helpersToRemoveForJs as helpersToRemoveForJs };
+declare function defaultJSSetup(): void;
+declare const _defaultJSSetup: typeof defaultJSSetup;
+export { _defaultJSSetup as defaultJSSetup };