@promptbook/core 0.31.0-1 → 0.31.0-10

package/umd/typings/utils/FromtoItems.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Represents items which are compared to each other
+ */
+export type FromtoItems = Array<{
+    /**
+     * The title of the item
+     */
+    title: string;
+    /**
+     * The start of the item
+     *
+     * This can mean anything, like seconds, milliseconds, dollars, etc.
+     */
+    from: number;
+    /**
+     * The end of the item
+     */
+    to: number;
+}>;

package/umd/typings/utils/extractParameters.d.ts

@@ -4,5 +4,7 @@ import { string_name, string_template } from '../types/typeAliases';
  *
  * @param template the template with parameters in {curly} braces
  * @returns the list of parameter names
+ *
+ * @private within the library
  */
 export declare function extractParameters(template: string_template): Array<string_name>;

package/umd/typings/utils/extractVariables.d.ts

@@ -0,0 +1,10 @@
+import { string_javascript, string_javascript_name } from '../types/typeAliases';
+/**
+ * Parses the given script and returns the list of all used variables that are not defined in the script
+ *
+ * @param script from which to extract the variables
+ * @returns the list of variable names
+ *
+ * @private within the library
+ */
+export declare function extractVariables(script: string_javascript): Array<string_javascript_name>;

package/umd/typings/utils/extractVariables.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/formatNumber.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Format either small or big number
+ *
+ * @private within the library
+ */
+export declare function formatNumber(value: number): string;

package/umd/typings/utils/formatNumber.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/markdown/createMarkdownChart.d.ts

@@ -0,0 +1,37 @@
+import { string_markdown } from '../../types/typeAliases';
+import { FromtoItems } from '../FromtoItems';
+/**
+ * Options for creating a markdown chart
+ */
+/**
+ * Options for creating a markdown chart.
+ */
+type CreateMarkdownChartOptions = {
+    /**
+     * The header for the first column - the name of the item
+     */
+    nameHeader: string;
+    /**
+     * The header for the second column - the value of the item
+     */
+    valueHeader: string;
+    /**
+     * The items to be charted
+     */
+    items: FromtoItems;
+    /**
+     * The width of the chart in squares
+     */
+    width: number;
+    /**
+     * The name of the unit shown in the chart
+     */
+    unitName: string;
+};
+/**
+ * Function createMarkdownChart will draw a chart in markdown from ⬛+🟦 tiles
+ *
+ * @private within the library
+ */
+export declare function createMarkdownChart(options: CreateMarkdownChartOptions): string_markdown;
+export {};

package/umd/typings/utils/markdown/createMarkdownChart.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/markdown/createMarkdownTable.d.ts

@@ -0,0 +1,7 @@
+import { string_markdown, string_markdown_text } from '../../types/typeAliases';
+/**
+ * Create a markdown table from a 2D array of strings
+ *
+ * @private within the library
+ */
+export declare function createMarkdownTable(table: Array<Array<string_markdown_text>>): string_markdown;

package/umd/typings/utils/markdown/createMarkdownTable.test.d.ts

@@ -0,0 +1 @@
+export {};

package/umd/typings/utils/replaceParameters.d.ts

@@ -6,5 +6,7 @@ import { Parameters } from '../types/Parameters';
  * @param template the template with parameters in {curly} braces
  * @param parameters the object with parameters
  * @returns the template with replaced parameters
+ *
+ * @private within the library
  */
 export declare function replaceParameters(template: string_template, parameters: Parameters): string;