@genesislcap/expression-builder 14.302.0 → 14.302.1-alpha-945e484.0

package/dist/dts/main/expression-rule/expression-rule.helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"expression-rule.helpers.d.ts","sourceRoot":"","sources":["../../../../src/main/expression-rule/expression-rule.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,QAAQ,EACR,IAAI,EAIL,MAAM,aAAa,CAAC;AAIrB;;;;;GAKG;AACH,eAAO,MAAM,UAAU,WAAY,QAAQ,KAAK,SAAS,QAC4B,CAAC;AAEtF;;;GAGG;AACH,eAAO,MAAM,QAAQ,WAAY,QAAQ,KAAK,SAAS,aAAa,MAAM,QAOzE,CAAC;AAEF,eAAO,MAAM,YAAY,WAAY,QAAQ,KAAK,SAAS,uBA2B1D,CAAC;AAEF,eAAO,MAAM,2BAA2B,gBAAiB,QAAQ,SAAS,SAAS,KAAG,IAgCrF,CAAC;AAEF,eAAO,MAAM,uBAAuB,UAAW,SAAS,SAAS,GAAG,YAAY,MAAM,KAAG,IAqBxF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,MAAO,GAAG,YAAkB,CAAC;AAExD,eAAO,MAAM,kBAAkB,UAAW,SAAS,KAAG,OASrD,CAAC"}
+{"version":3,"file":"expression-rule.helpers.d.ts","sourceRoot":"","sources":["../../../../src/main/expression-rule/expression-rule.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,SAAS,EACT,QAAQ,EACR,IAAI,EAIL,MAAM,aAAa,CAAC;AAIrB;;;;;GAKG;AACH,eAAO,MAAM,UAAU,GAAI,QAAQ,QAAQ,EAAE,GAAG,SAAS,QAC4B,CAAC;AAEtF;;;GAGG;AACH,eAAO,MAAM,QAAQ,GAAI,QAAQ,QAAQ,EAAE,GAAG,SAAS,MAAM,OAAO,MAAM,QAOzE,CAAC;AAEF,eAAO,MAAM,YAAY,GAAI,QAAQ,QAAQ,EAAE,GAAG,SAAS,uBA2B1D,CAAC;AAEF,eAAO,MAAM,2BAA2B,GAAI,aAAa,QAAQ,EAAE,OAAO,SAAS,KAAG,IAgCrF,CAAC;AAEF,eAAO,MAAM,uBAAuB,GAAI,OAAO,SAAS,EAAE,OAAO,GAAG,EAAE,UAAU,MAAM,KAAG,IAqBxF,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,cAAc,GAAI,GAAG,GAAG,YAAkB,CAAC;AAExD,eAAO,MAAM,kBAAkB,GAAI,OAAO,SAAS,KAAG,OASrD,CAAC"}

package/dist/dts/main/rule-value/rule-value.helpers.d.ts

@@ -1,6 +1,6 @@
 import { Field } from '../../types';
-export declare const isIntType: (type: Field['type']) => boolean;
-export declare const isFloatType: (type: Field['type']) => boolean;
-export declare const pattern: (type: Field['type']) => RegExp;
-export declare const numberPatternValidator: (type: Field['type'], value: string) => string | null;
+export declare const isIntType: (type: Field["type"]) => boolean;
+export declare const isFloatType: (type: Field["type"]) => boolean;
+export declare const pattern: (type: Field["type"]) => RegExp;
+export declare const numberPatternValidator: (type: Field["type"], value: string) => string | null;
 //# sourceMappingURL=rule-value.helpers.d.ts.map

package/dist/dts/main/rule-value/rule-value.helpers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rule-value.helpers.d.ts","sourceRoot":"","sources":["../../../../src/main/rule-value/rule-value.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,eAAO,MAAM,SAAS,SAAU,KAAK,CAAC,MAAM,CAAC,YAA4C,CAAC;AAE1F,eAAO,MAAM,WAAW,SAAU,KAAK,CAAC,MAAM,CAAC,YAA4C,CAAC;AAE5F,eAAO,MAAM,OAAO,SAAU,KAAK,CAAC,MAAM,CAAC,WAQ1C,CAAC;AAEF,eAAO,MAAM,sBAAsB,SAAU,KAAK,CAAC,MAAM,CAAC,SAAS,MAAM,KAAG,MAAM,GAAG,IAEpF,CAAC"}
+{"version":3,"file":"rule-value.helpers.d.ts","sourceRoot":"","sources":["../../../../src/main/rule-value/rule-value.helpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAEpC,eAAO,MAAM,SAAS,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,YAA4C,CAAC;AAE1F,eAAO,MAAM,WAAW,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,YAA4C,CAAC;AAE5F,eAAO,MAAM,OAAO,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,WAQ1C,CAAC;AAEF,eAAO,MAAM,sBAAsB,GAAI,MAAM,KAAK,CAAC,MAAM,CAAC,EAAE,OAAO,MAAM,KAAG,MAAM,GAAG,IAEpF,CAAC"}

package/dist/dts/utils/formatting.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../../src/utils/formatting.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,SAAU,IAAI,WAK1C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,SAAU,IAAI,WAM9C,CAAC"}
+{"version":3,"file":"formatting.d.ts","sourceRoot":"","sources":["../../../src/utils/formatting.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,eAAO,MAAM,gBAAgB,GAAI,MAAM,IAAI,WAK1C,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,oBAAoB,GAAI,MAAM,IAAI,WAM9C,CAAC"}

package/dist/dts/utils/misc.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"misc.d.ts","sourceRoot":"","sources":["../../../src/utils/misc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEnE,eAAO,MAAM,aAAa,YAAa,SAAS,GAAG,SAAS,0EACD,CAAC;AAE5D,eAAO,MAAM,YAAY,YAAa,SAAS,GAAG,SAAS,8GACF,CAAC;AAE1D,eAAO,MAAM,gBAAgB;cAET,MAAM,GAAG,IAAI;;IAyChC,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,WAAW,EACtB,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,QAAQ,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,GAClD,IAAI,CAeN"}
+{"version":3,"file":"misc.d.ts","sourceRoot":"","sources":["../../../src/utils/misc.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,+BAA+B,CAAC;AAC/D,OAAO,KAAK,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAEnE,eAAO,MAAM,aAAa,GAAI,SAAS,SAAS,GAAG,SAAS,0EACD,CAAC;AAE5D,eAAO,MAAM,YAAY,GAAI,SAAS,SAAS,GAAG,SAAS,8GACF,CAAC;AAE1D,eAAO,MAAM,gBAAgB,GAAI,CAAC,SAAS,QAAQ,GAAG,KAAK,EACzD,IAAI,CAAC,EAAE,KACN,CAAC,CAAC,GAAG;IAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,EAAE,EAAE,CAAC,EAAE,CAAA;CAAE,CAAC,EAyC5C,CAAC;AAEF;;;;;;GAMG;AACH,wBAAgB,iBAAiB,CAC/B,SAAS,EAAE,WAAW,EACtB,MAAM,EAAE,MAAM,GAAG,SAAS,GAAG,IAAI,EACjC,QAAQ,EAAE,MAAM,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,GAClD,IAAI,CAeN"}

package/dist/expression-builder.api.json

@@ -1,7 +1,7 @@
 {
   "metadata": {
     "toolPackage": "@microsoft/api-extractor",
-    "toolVersion": "7.34.9",
+    "toolVersion": "7.52.10",
     "schemaVersion": 1011,
     "oldestForwardsCompatibleVersion": 1001,
     "tsdocConfig": {
@@ -222,6 +222,34 @@
                 "endIndex": 3
               }
             },
+            {
+              "kind": "Variable",
+              "canonicalReference": "@genesislcap/expression-builder!Config.BASE_OPERATORS:var",
+              "docComment": "/**\n * *\n *\n * @alpha\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "BASE_OPERATORS: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Operator",
+                  "canonicalReference": "@genesislcap/expression-builder!Types.Operator:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]"
+                }
+              ],
+              "fileUrlPath": "src/config/operators.ts",
+              "isReadonly": true,
+              "releaseTag": "Alpha",
+              "name": "BASE_OPERATORS",
+              "variableTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 3
+              }
+            },
             {
               "kind": "Variable",
               "canonicalReference": "@genesislcap/expression-builder!Config.LOGICAL_COMBINATORS:var",
@@ -469,17 +497,55 @@
           ]
         },
         {
-          "kind": "Variable",
-          "canonicalReference": "@genesislcap/expression-builder!formatDateString:var",
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/expression-builder!formatDateString:function(1)",
           "docComment": "/**\n * Gets the string representation from a `Date` which is the format a `date` input uses. `yyyy-mm-dd`. Uses UTC methods to ensure consistent output regardless of timezone.\n *\n * Used to convert a javascript date object into the required string format expected by the expression builder.\n *\n * @beta\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "formatDateString: "
+              "text": "formatDateString: (date: "
+            },
+            {
+              "kind": "Reference",
+              "text": "Date",
+              "canonicalReference": "!Date:interface"
             },
             {
               "kind": "Content",
-              "text": "(date: "
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
+            }
+          ],
+          "fileUrlPath": "src/utils/formatting.ts",
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
+          "releaseTag": "Beta",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "date",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "formatDateString"
+        },
+        {
+          "kind": "Function",
+          "canonicalReference": "@genesislcap/expression-builder!formatDateTimeString:function(1)",
+          "docComment": "/**\n * Gets the string representation from a `Date` which is the format a `datetime-local` input uses. `yyyy-mm-ddThh:mm:ss`. Uses UTC methods to ensure consistent output regardless of timezone.\n *\n * Used to convert a javascript date object into the required string format expected by the expression builder.\n *\n * @beta\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "formatDateTimeString: (date: "
             },
             {
               "kind": "Reference",
@@ -488,48 +554,99 @@
             },
             {
               "kind": "Content",
-              "text": ") => string"
+              "text": ") => "
+            },
+            {
+              "kind": "Content",
+              "text": "string"
             }
           ],
           "fileUrlPath": "src/utils/formatting.ts",
-          "isReadonly": true,
+          "returnTypeTokenRange": {
+            "startIndex": 3,
+            "endIndex": 4
+          },
           "releaseTag": "Beta",
-          "name": "formatDateString",
+          "overloadIndex": 1,
+          "parameters": [
+            {
+              "parameterName": "date",
+              "parameterTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              },
+              "isOptional": false
+            }
+          ],
+          "name": "formatDateTimeString"
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/expression-builder!styles:var",
+          "docComment": "/**\n * *\n *\n * @alpha\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "styles: "
+            },
+            {
+              "kind": "Content",
+              "text": "import(\"@microsoft/fast-element\")."
+            },
+            {
+              "kind": "Reference",
+              "text": "ElementStyles",
+              "canonicalReference": "@microsoft/fast-element!ElementStyles:class"
+            }
+          ],
+          "fileUrlPath": "src/main/expression-builder.styles.ts",
+          "isReadonly": true,
+          "releaseTag": "Alpha",
+          "name": "styles",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 3
           }
         },
         {
           "kind": "Variable",
-          "canonicalReference": "@genesislcap/expression-builder!formatDateTimeString:var",
-          "docComment": "/**\n * Gets the string representation from a `Date` which is the format a `datetime-local` input uses. `yyyy-mm-ddThh:mm:ss`. Uses UTC methods to ensure consistent output regardless of timezone.\n *\n * Used to convert a javascript date object into the required string format expected by the expression builder.\n *\n * @beta\n */\n",
+          "canonicalReference": "@genesislcap/expression-builder!template:var",
+          "docComment": "/**\n * *\n *\n * @alpha\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "formatDateTimeString: "
+              "text": "template: "
             },
             {
               "kind": "Content",
-              "text": "(date: "
+              "text": "import(\"@microsoft/fast-element\")."
             },
             {
               "kind": "Reference",
-              "text": "Date",
-              "canonicalReference": "!Date:interface"
+              "text": "ViewTemplate",
+              "canonicalReference": "@microsoft/fast-element!ViewTemplate:class"
             },
             {
               "kind": "Content",
-              "text": ") => string"
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "ExpressionBuilder",
+              "canonicalReference": "@genesislcap/expression-builder!ExpressionBuilder:class"
+            },
+            {
+              "kind": "Content",
+              "text": ", any>"
             }
           ],
-          "fileUrlPath": "src/utils/formatting.ts",
+          "fileUrlPath": "src/main/expression-builder.template.ts",
           "isReadonly": true,
-          "releaseTag": "Beta",
-          "name": "formatDateTimeString",
+          "releaseTag": "Alpha",
+          "name": "template",
           "variableTypeTokenRange": {
             "startIndex": 1,
-            "endIndex": 4
+            "endIndex": 6
           }
         },
         {

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.34.9"
+      "packageVersion": "7.52.10"
     }
   ]
 }

package/docs/api/expression-builder.config.base_operators.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/expression-builder](./expression-builder.md) &gt; [Config](./expression-builder.config.md) &gt; [BASE\_OPERATORS](./expression-builder.config.base_operators.md)
+
+## Config.BASE\_OPERATORS variable
+
+> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+> 
+
+\*
+
+**Signature:**
+
+```typescript
+BASE_OPERATORS: Operator[]
+```

package/docs/api/expression-builder.config.md

@@ -6,9 +6,62 @@
 
 ## Variables
 
-|  Variable | Description |
-|  --- | --- |
-|  [BASE\_LOGICAL\_COMBINATORS](./expression-builder.config.base_logical_combinators.md) | **_(BETA)_** Basic <code>AND</code> and <code>OR</code> logical combinators which can be used in the model config. |
-|  [LOGICAL\_COMBINATORS](./expression-builder.config.logical_combinators.md) | **_(BETA)_** A set of boolean logic combinators which configure the expression builder to produce boolean expressions. |
-|  [NULL\_COMBINATOR](./expression-builder.config.null_combinator.md) | <p>**_(BETA)_** A combinator which has a null action.</p><p>If configured as the only combinator then it configures the expression builder to only create a single rule.</p> |
+<table><thead><tr><th>
+
+Variable
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[BASE\_LOGICAL\_COMBINATORS](./expression-builder.config.base_logical_combinators.md)
+
+
+</td><td>
+
+**_(BETA)_** Basic `AND` and `OR` logical combinators which can be used in the model config.
+
+
+</td></tr>
+<tr><td>
+
+[BASE\_OPERATORS](./expression-builder.config.base_operators.md)
+
+
+</td><td>
+
+**_(ALPHA)_** \*
+
+
+</td></tr>
+<tr><td>
+
+[LOGICAL\_COMBINATORS](./expression-builder.config.logical_combinators.md)
+
+
+</td><td>
+
+**_(BETA)_** A set of boolean logic combinators which configure the expression builder to produce boolean expressions.
+
+
+</td></tr>
+<tr><td>
+
+[NULL\_COMBINATOR](./expression-builder.config.null_combinator.md)
+
+
+</td><td>
+
+**_(BETA)_** A combinator which has a null action.
+
+If configured as the only combinator then it configures the expression builder to only create a single rule.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/expression-builder.expressionbuilder.dispatchchangeevent.md

@@ -17,9 +17,37 @@ protected dispatchChangeEvent(group: Group): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  group | [Group](./expression-builder.types.group.md) |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+group
+
+
+</td><td>
+
+[Group](./expression-builder.types.group.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/expression-builder.expressionbuilder.md

@@ -26,15 +26,127 @@ export declare class ExpressionBuilder extends GenesisElement implements Metadat
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [config](./expression-builder.expressionbuilder.config.md) |  | Config | <p>**_(BETA)_** config - <code>Types.Config</code> the configuration which is required to be set for the expression builder. All properties are defined under this single object to enforce that they're kept in sync with one another.</p><p>If you want to set the expression of the expression builder you should do it via the <code>model</code> property on this object.</p><p>If you're using a child class of this component with a specific model implementation you likely \*don't\* want to set this property directly. See example 3.</p> |
-|  [model](./expression-builder.expressionbuilder.model.md) |  | ModelGroup \| null | <p>**_(BETA)_** model - <code>Types.Group</code> the current model which completely describes the state of the component.</p><p>\*IMPORTANT\* you should not set this yourself via this property directly, you should always set it via the model property on the [ExpressionBuilder.config](./expression-builder.expressionbuilder.config.md) block.</p><p>You may want to read from this variable to get the most up to date state, for example if you create a child component which has a model which isn't valid for every single state (e.g. requires a complete rule) you can check this underlying model to verify what field or operator is selected.</p> |
-|  [styles?](./expression-builder.expressionbuilder.styles.md) |  | [Styles](./expression-builder.types.styles.md) | **_(BETA)_** _(Optional)_ styles - <code>Types.Styles</code> optional configuration which allows you to set custom element tag names to be used, as well as custom css to be inserted into the shadow DOM. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[config](./expression-builder.expressionbuilder.config.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Config
+
+
+</td><td>
+
+**_(BETA)_** config - `Types.Config` the configuration which is required to be set for the expression builder. All properties are defined under this single object to enforce that they're kept in sync with one another.
+
+If you want to set the expression of the expression builder you should do it via the `model` property on this object.
+
+If you're using a child class of this component with a specific model implementation you likely \*don't\* want to set this property directly. See example 3.
+
+
+</td></tr>
+<tr><td>
+
+[model](./expression-builder.expressionbuilder.model.md)
+
+
+</td><td>
+
+
+</td><td>
+
+ModelGroup \| null
+
+
+</td><td>
+
+**_(BETA)_** model - `Types.Group` the current model which completely describes the state of the component.
+
+\*IMPORTANT\* you should not set this yourself via this property directly, you should always set it via the model property on the [ExpressionBuilder.config](./expression-builder.expressionbuilder.config.md) block.
+
+You may want to read from this variable to get the most up to date state, for example if you create a child component which has a model which isn't valid for every single state (e.g. requires a complete rule) you can check this underlying model to verify what field or operator is selected.
+
+
+</td></tr>
+<tr><td>
+
+[styles?](./expression-builder.expressionbuilder.styles.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Styles](./expression-builder.types.styles.md)
+
+
+</td><td>
+
+**_(BETA)_** _(Optional)_ styles - `Types.Styles` optional configuration which allows you to set custom element tag names to be used, as well as custom css to be inserted into the shadow DOM.
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [dispatchChangeEvent(group)](./expression-builder.expressionbuilder.dispatchchangeevent.md) | <code>protected</code> | **_(BETA)_** Dispatches the provided model to the DOM. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[dispatchChangeEvent(group)](./expression-builder.expressionbuilder.dispatchchangeevent.md)
+
+
+</td><td>
+
+`protected`
+
+
+</td><td>
+
+**_(BETA)_** Dispatches the provided model to the DOM.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/expression-builder.formatdatestring.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/expression-builder](./expression-builder.md) > [formatDateString](./expression-builder.formatdatestring.md)
 
-## formatDateString variable
+## formatDateString() function
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
@@ -16,3 +16,42 @@ Used to convert a javascript date object into the required string format expecte
 ```typescript
 formatDateString: (date: Date) => string
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+date
+
+
+</td><td>
+
+Date
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+

package/docs/api/expression-builder.formatdatetimestring.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/expression-builder](./expression-builder.md) > [formatDateTimeString](./expression-builder.formatdatetimestring.md)
 
-## formatDateTimeString variable
+## formatDateTimeString() function
 
 > This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
 > 
@@ -16,3 +16,42 @@ Used to convert a javascript date object into the required string format expecte
 ```typescript
 formatDateTimeString: (date: Date) => string
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+date
+
+
+</td><td>
+
+Date
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+string
+