npm - @genesislcap/foundation-criteria - Versions diffs - 14.408.0 → 14.409.0 - Mend

@genesislcap/foundation-criteria 14.408.0 → 14.409.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

package/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabel.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [selectedLabel](./foundation-criteria.criteriasegmentedcontrol.selectedlabel.md)
-## CriteriaSegmentedControl.selectedLabel property
-**Signature:**
-```typescript
-selectedLabel: string;
-```

package/docs/api/foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [selectedLabelChanged](./foundation-criteria.criteriasegmentedcontrol.selectedlabelchanged.md)
-## CriteriaSegmentedControl.selectedLabelChanged() method
-**Signature:**
-```typescript
-selectedLabelChanged(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-criteria.criteriasegmentedcontrol.value.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [value](./foundation-criteria.criteriasegmentedcontrol.value.md)
-## CriteriaSegmentedControl.value property
-**Signature:**
-```typescript
-value: string;
-```

package/docs/api/foundation-criteria.criteriasegmentedcontrol.valuechanged.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [CriteriaSegmentedControl](./foundation-criteria.criteriasegmentedcontrol.md) &gt; [valueChanged](./foundation-criteria.criteriasegmentedcontrol.valuechanged.md)
-## CriteriaSegmentedControl.valueChanged() method
-**Signature:**
-```typescript
-valueChanged(): void;
-```
-**Returns:**
-void

package/docs/api/foundation-criteria.expressionbuilder._constructor_.md DELETED Viewed

@@ -1,57 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [(constructor)](./foundation-criteria.expressionbuilder._constructor_.md)
-## ExpressionBuilder.(constructor)
-Constructs a new instance of the `ExpressionBuilder` class
-**Signature:**
-```typescript
-constructor(opts?: Partial<{
-        field: string;
-        value: unknown;
-        serialiser: Serialiser;
-        params: any;
-        valueGetter: (value: unknown) => string;
-        group: string;
-    }>);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-opts
-</td><td>
-Partial&lt;{ field: string; value: unknown; serialiser: Serialiser; params: any; valueGetter: (value: unknown) =&gt; string; group: string; }&gt;
-</td><td>
-_(Optional)_
-</td></tr>
-</tbody></table>

package/docs/api/foundation-criteria.expressionbuilder.build.md DELETED Viewed

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [build](./foundation-criteria.expressionbuilder.build.md)
-## ExpressionBuilder.build property
-**Signature:**
-```typescript
-build: () => Expression;
-```

package/docs/api/foundation-criteria.expressionbuilder.md DELETED Viewed

@@ -1,181 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md)
-## ExpressionBuilder class
-**Signature:**
-```typescript
-export declare class ExpressionBuilder
-```
-## Constructors
-<table><thead><tr><th>
-Constructor
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[(constructor)(opts)](./foundation-criteria.expressionbuilder._constructor_.md)
-</td><td>
-</td><td>
-Constructs a new instance of the `ExpressionBuilder` class
-</td></tr>
-</tbody></table>
-## Properties
-<table><thead><tr><th>
-Property
-</th><th>
-Modifiers
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[build](./foundation-criteria.expressionbuilder.build.md)
-</td><td>
-</td><td>
-() =&gt; Expression
-</td><td>
-</td></tr>
-</tbody></table>
-## Methods
-<table><thead><tr><th>
-Method
-</th><th>
-Modifiers
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-[withField(field)](./foundation-criteria.expressionbuilder.withfield.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withGroup(group)](./foundation-criteria.expressionbuilder.withgroup.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withParams(params)](./foundation-criteria.expressionbuilder.withparams.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withSerialiser(serialiser)](./foundation-criteria.expressionbuilder.withserialiser.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withValue(value)](./foundation-criteria.expressionbuilder.withvalue.md)
-</td><td>
-</td><td>
-</td></tr>
-<tr><td>
-[withValueGetter(valueGetter)](./foundation-criteria.expressionbuilder.withvaluegetter.md)
-</td><td>
-</td><td>
-</td></tr>
-</tbody></table>

package/docs/api/foundation-criteria.expressionbuilder.withfield.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withField](./foundation-criteria.expressionbuilder.withfield.md)
-## ExpressionBuilder.withField() method
-**Signature:**
-```typescript
-withField(field: string): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-field
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionbuilder.withgroup.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withGroup](./foundation-criteria.expressionbuilder.withgroup.md)
-## ExpressionBuilder.withGroup() method
-**Signature:**
-```typescript
-withGroup(group: string): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-group
-</td><td>
-string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionbuilder.withparams.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withParams](./foundation-criteria.expressionbuilder.withparams.md)
-## ExpressionBuilder.withParams() method
-**Signature:**
-```typescript
-withParams(params: any): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-params
-</td><td>
-any
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionbuilder.withserialiser.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withSerialiser](./foundation-criteria.expressionbuilder.withserialiser.md)
-## ExpressionBuilder.withSerialiser() method
-**Signature:**
-```typescript
-withSerialiser(serialiser: Serialiser): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-serialiser
-</td><td>
-Serialiser
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionbuilder.withvalue.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withValue](./foundation-criteria.expressionbuilder.withvalue.md)
-## ExpressionBuilder.withValue() method
-**Signature:**
-```typescript
-withValue(value: unknown): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-value
-</td><td>
-unknown
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionbuilder.withvaluegetter.md DELETED Viewed

@@ -1,50 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionBuilder](./foundation-criteria.expressionbuilder.md) &gt; [withValueGetter](./foundation-criteria.expressionbuilder.withvaluegetter.md)
-## ExpressionBuilder.withValueGetter() method
-**Signature:**
-```typescript
-withValueGetter(valueGetter: (value: unknown) => string): ExpressionBuilder;
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-valueGetter
-</td><td>
-(value: unknown) =&gt; string
-</td><td>
-</td></tr>
-</tbody></table>
-**Returns:**
-[ExpressionBuilder](./foundation-criteria.expressionbuilder.md)

package/docs/api/foundation-criteria.expressionconfig.md DELETED Viewed

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionConfig](./foundation-criteria.expressionconfig.md)
-## ExpressionConfig type
-Interface for fields to implement to generate expression criteria
-**Signature:**
-```typescript
-export type ExpressionConfig<T = unknown, V = unknown, Y = unknown> = {
-    criteria: (value: V, filters: T) => ExpressionParams<Y> | Array<ExpressionParams<Y>>;
-};
-```

package/docs/api/foundation-criteria.expressionconfigmap.md DELETED Viewed

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [ExpressionConfigMap](./foundation-criteria.expressionconfigmap.md)
-## ExpressionConfigMap type
-Maps form fields to expression configuration
-**Signature:**
-```typescript
-export type ExpressionConfigMap<T, Y = unknown> = Partial<{
-    [key in keyof T]: ExpressionConfig<T, T[key], Y>;
-}>;
-```
-**References:** [ExpressionConfig](./foundation-criteria.expressionconfig.md)

package/docs/api/foundation-criteria.join._constructor_.md DELETED Viewed

@@ -1,48 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-[Home](./index.md) &gt; [@genesislcap/foundation-criteria](./foundation-criteria.md) &gt; [Join](./foundation-criteria.join.md) &gt; [(constructor)](./foundation-criteria.join._constructor_.md)
-## Join.(constructor)
-Constructs a new instance of the `Join` class
-**Signature:**
-```typescript
-constructor(type: Operator);
-```
-## Parameters
-<table><thead><tr><th>
-Parameter
-</th><th>
-Type
-</th><th>
-Description
-</th></tr></thead>
-<tbody><tr><td>
-type
-</td><td>
-Operator
-</td><td>
-</td></tr>
-</tbody></table>