@bridgeline-digital/hawksearch-handlebars-ui 6.1.4 → 6.1.7

package/dist/helpers/helpers.d.ts

@@ -1,221 +0,0 @@
-/**
- * This function returns the sum of two values.
- *
- * ### Example
- *
- * ```hbs
- * {{sum 1 2}}
- * ```
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Sum
- */
-export declare function add(value1: number, value2: number): number;
-/**
- * This function returns whether all values resolve to `true`.
- *
- * ### Example
- *
- * ```hbs
- * {{#if (and value1 value1)}}
- *   <span>Conditional content</span>
- * {{/if}}
- * ```
- *
- * @param values Array of value
- * @returns `true` if all values resolve to `true`, otherwise `false`
- */
-export declare function and(...values: Array<any>): boolean;
-/**
- * This function renders an inline attribute when `condition` resolves to `true`.
- *
- * ### Example
- *
- * ```hbs
- * <div{{attribute ' style="display: block;"' visible}}></div>
- * ```
- *
- * @param attribute The attribute to be rendered
- * @param condition The value that is evaluated to determine whether to render `attribute`
- * @returns `attribute` if `condition` resolves to `true`, otherwise an empty string
- */
-export declare function attribute(attribute: string, condition: any): Handlebars.SafeString;
-/**
- * This function concatenates multiple values into a single string
- *
- * ### Example
- *
- * ```hbs
- * <div{{attribute (concat 'style="max-height: ' maxHeight 'px;"') maxHeight}}></div>
- * ```
- *
- * @param values Array of values
- * @returns Concatenated string
- */
-export declare function concat(...values: Array<any>): string;
-/**
- * This function returns whether the supplied values are equal to each other.
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Whether `value1` and `value2` are equal
- */
-export declare function eq(value1: any, value2: any): boolean;
-/**
- * This function is used to prevent Handlebars from attempting to bind a data model to a nested control containing a custom template.
- *
- * ### Example
- *
- * ```hbs
- * <hawksearch-results>
- *   {{{{exclude}}}}
- * 	   <hawksearch-pagination>
- * 	     {{#if displayFirstLink}}
- *         <a hawksearch-page="1">First</a>
- * 	     {{/if}}
- *       {{#if displayLastLink}}
- *         <a hawksearch-page="{{totalPages}}">Last</a>
- *       {{/if}}
- *     </hawksearch-pagination>
- *   {{{{/exclude}}}}
- * </hawksearch-results>
- * ```
- *
- * @param options Automatically added by Handlebars
- * @returns The preserved Handlebars template without binding it to the parent component data object
- */
-export declare function exclude(options: any): any;
-/**
- * This function is used to render a provided string as HTML rather than escape special characters.
- *
- * @param html HTML string
- * @returns Unencoded HTML string
- */
-export declare function html(html: string): Handlebars.SafeString;
-/**
- * This function formats a value as currency
- *
- * @param value Number to be formatted
- * @param decimals Number of decimal places to display
- * @param defaultValue Default value
- * @returns Formatted currency string
- */
-export declare function currency(value: number | string | Array<number> | Array<string> | undefined, decimals: number | undefined, defaultValue?: number): string | undefined;
-/**
- * This function filters an array of objects based on whether a specified property value matches an optional condition, or, if omitted, has a truthy value
- *
- * @param values Array of objects to be filtered
- * @param path Name of property or nested path to evaluate each object
- * @param condition Optional condition
- * @returns Formatted currency string
- */
-export declare function arrayFilterObjects(values: Array<any | undefined>, path: string, condition?: any): Array<any> | undefined;
-/**
- * This function returns whether any object in an array has a specified property value which matches an optional condition, or, if omitted, has a truthy value
- *
- * @param values Array of objects to be filtered
- * @param path Name of property or nested path to evaluate each object
- * @param condition Optional condition
- * @returns Formatted currency string
- */
-export declare function arrayHasObjectsWithValue(values: Array<any | undefined>, path: string, condition?: any): boolean;
-/**
- * This function returns whether the first provided value is greater than the second provided value.
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Whether `value1` is greater than `value2`
- */
-export declare function gt(value1: any, value2: any): boolean;
-/**
- * This function returns whether the first provided value is greater than or equal to the second provided value.
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Whether `value1` is greater than or equal to `value2`
- */
-export declare function gte(value1: any, value2: any): boolean;
-/**
- * This function is used to render different content inline depending on whether a condition resolves to `true` or `false`.
- *
- * ### Example
- * ```hbs
- * <hawksearch-icon name="{{if-else toggled 'chevron-down' 'chevron-right'}}"></hawksearch-icon>
- * ```
- *
- * @param condition Condition to be evaluated
- * @param trueValue The value to be returned if `condition` resolves to `true`
- * @param falseValue The value to be returned if `condition` resolves to `false`
- * @returns Either `trueValue` or `falseValue` depending on `condition`
- */
-export declare function ifElse(condition: any, trueValue: any, falseValue: any): any;
-/**
- * This function returns whether the first provided value is less than the second provided value.
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Whether `value1` is less than `value2`
- */
-export declare function lt(value1: any, value2: any): boolean;
-/**
- * This function returns whether the first provided value is less than or equal to the second provided value.
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Whether `value1` is less than or equal to `value2`
- */
-export declare function lte(value1: any, value2: any): boolean;
-/**
- * This function formats a number.
- *
- * @param value Number to be formatted
- * @param decimals Number of decimal places to display
- * @param defaultValue Default value
- * @returns Formatted number string
- */
-export declare function number(value: number | string | Array<number> | Array<string> | undefined, decimals: number | undefined, defaultValue?: number): string | undefined;
-/**
- * This function returns whether any provided value resolves to `true`.
- *
- * @param values Array of values
- * @returns Whether any value resolves to `true`
- */
-export declare function or(...values: Array<any>): boolean;
-/**
- * This function displays a specified string with an optional default value.
- *
- * @param value Value to be returned
- * @param defaultValue Default value if `value` does not resolve to `true`
- * @returns `value` if it resolves to `true`, otherwise `defaultValue`
- */
-export declare function string(value: string | Array<string> | undefined, defaultValue?: string): string | undefined;
-/**
- * This function returns the difference of two values
- *
- * @param value1 First value
- * @param value2 Second value
- * @returns Difference
- */
-export declare function subtract(value1: number, value2: number): number;
-/**
- * This function returns a decoded URI string
- *
- * @param value HTML value
- * @returns Decoded URI value
- */
-export declare function decode(value: string): string;
-/**
- * This function returns a recursively decoded URI string
- *
- * @param value HTML value
- * @returns Decoded URI value
- */
-export declare function decodeNested(value: string): string;
-/**
- * This function is a wrapper of Lodash: { escapeRegExp }
- *
- * @param string — The string to escape.
- * @return — Returns the escaped string.
- */
-export declare function escapeRegExp(value: string): string;

package/dist/helpers/index.d.ts

@@ -1,4 +0,0 @@
-/**
- * @module Helpers
- */
-export * from './helpers';