@genesislcap/foundation-filters 9.0.1-alpha-b5c5eb7.0

package/docs/api/foundation-filters.defaulturltargeting.filter.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultURLTargeting](./foundation-filters.defaulturltargeting.md) &gt; [filter](./foundation-filters.defaulturltargeting.filter.md)
+
+## DefaultURLTargeting.filter() method
+
+**Signature:**
+
+```typescript
+filter(params: URLTargetingParams): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | [URLTargetingParams](./foundation-filters.urltargetingparams.md) |  |
+
+**Returns:**
+
+boolean
+
+The filter outcome.
+

package/docs/api/foundation-filters.defaulturltargeting.issecure.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultURLTargeting](./foundation-filters.defaulturltargeting.md) &gt; [isSecure](./foundation-filters.defaulturltargeting.issecure.md)
+
+## DefaultURLTargeting.isSecure() method
+
+**Signature:**
+
+```typescript
+isSecure(url: any): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  url | any | A url. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+Check if a url is secure.
+

package/docs/api/foundation-filters.defaulturltargeting.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultURLTargeting](./foundation-filters.defaulturltargeting.md)
+
+## DefaultURLTargeting class
+
+Default URLTargeting DI implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultURLTargeting implements URLTargeting 
+```
+**Implements:** [URLTargeting](./foundation-filters.urltargeting.md)
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [filter(params)](./foundation-filters.defaulturltargeting.filter.md) |  |  |
+|  [isSecure(url)](./foundation-filters.defaulturltargeting.issecure.md) |  |  |
+

package/docs/api/foundation-filters.defaultuseragent.filter.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserAgent](./foundation-filters.defaultuseragent.md) &gt; [filter](./foundation-filters.defaultuseragent.filter.md)
+
+## DefaultUserAgent.filter() method
+
+**Signature:**
+
+```typescript
+filter(params: UserAgentParams): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | [UserAgentParams](./foundation-filters.useragentparams.md) |  |
+
+**Returns:**
+
+boolean
+
+The filter outcome.
+

package/docs/api/foundation-filters.defaultuseragent.issafari.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserAgent](./foundation-filters.defaultuseragent.md) &gt; [isSafari](./foundation-filters.defaultuseragent.issafari.md)
+
+## DefaultUserAgent.isSafari property
+
+**Signature:**
+
+```typescript
+get isSafari(): boolean;
+```
+
+## Remarks
+
+Is the user-agent safari.
+

package/docs/api/foundation-filters.defaultuseragent.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserAgent](./foundation-filters.defaultuseragent.md)
+
+## DefaultUserAgent class
+
+Default UserAgent DI implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultUserAgent implements UserAgent 
+```
+**Implements:** [UserAgent](./foundation-filters.useragent.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isSafari](./foundation-filters.defaultuseragent.issafari.md) | <code>readonly</code> | boolean |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [filter(params)](./foundation-filters.defaultuseragent.filter.md) |  |  |
+

package/docs/api/foundation-filters.defaultusertargeting._constructor_.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md) &gt; [(constructor)](./foundation-filters.defaultusertargeting._constructor_.md)
+
+## DefaultUserTargeting.(constructor)
+
+Constructs a new instance of the `DefaultUserTargeting` class
+
+**Signature:**
+
+```typescript
+constructor(auth: Auth);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  auth | Auth |  |
+

package/docs/api/foundation-filters.defaultusertargeting.auth.md

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

package/docs/api/foundation-filters.defaultusertargeting.filter.md

@@ -0,0 +1,24 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md) &gt; [filter](./foundation-filters.defaultusertargeting.filter.md)
+
+## DefaultUserTargeting.filter() method
+
+**Signature:**
+
+```typescript
+filter(params: UserTargetingParams): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  params | [UserTargetingParams](./foundation-filters.usertargetingparams.md) |  |
+
+**Returns:**
+
+boolean
+
+The filter outcome.
+

package/docs/api/foundation-filters.defaultusertargeting.hasadminprofile.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md) &gt; [hasAdminProfile](./foundation-filters.defaultusertargeting.hasadminprofile.md)
+
+## DefaultUserTargeting.hasAdminProfile property
+
+**Signature:**
+
+```typescript
+get hasAdminProfile(): boolean;
+```
+
+## Remarks
+
+Has the user got the 'ADMIN' profile assigned.
+

package/docs/api/foundation-filters.defaultusertargeting.isloggedin.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md) &gt; [isLoggedIn](./foundation-filters.defaultusertargeting.isloggedin.md)
+
+## DefaultUserTargeting.isLoggedIn property
+
+**Signature:**
+
+```typescript
+get isLoggedIn(): boolean;
+```
+
+## Remarks
+
+Has the user logged in, regardless of their identity.
+

package/docs/api/foundation-filters.defaultusertargeting.md

@@ -0,0 +1,35 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md)
+
+## DefaultUserTargeting class
+
+Default UserTargeting DI implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultUserTargeting implements UserTargeting 
+```
+**Implements:** [UserTargeting](./foundation-filters.usertargeting.md)
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(auth)](./foundation-filters.defaultusertargeting._constructor_.md) |  | Constructs a new instance of the <code>DefaultUserTargeting</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [auth](./foundation-filters.defaultusertargeting.auth.md) |  | Auth |  |
+|  [hasAdminProfile](./foundation-filters.defaultusertargeting.hasadminprofile.md) | <code>readonly</code> | boolean |  |
+|  [isLoggedIn](./foundation-filters.defaultusertargeting.isloggedin.md) | <code>readonly</code> | boolean |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [filter(params)](./foundation-filters.defaultusertargeting.filter.md) |  |  |
+

package/docs/api/foundation-filters.getfilterbyname.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [getFilterByName](./foundation-filters.getfilterbyname.md)
+
+## getFilterByName() function
+
+Filer lookup by name.
+
+**Signature:**
+
+```typescript
+export declare function getFilterByName(name: ClientFilterName, container: Container): NodeEnv | Percentage | TimeWindow | URLTargeting | UserAgent | UserTargeting;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  name | [ClientFilterName](./foundation-filters.clientfiltername.md) |  |
+|  container | Container |  |
+
+**Returns:**
+
+[NodeEnv](./foundation-filters.nodeenv.md) \| [Percentage](./foundation-filters.percentage.md) \| [TimeWindow](./foundation-filters.timewindow.md) \| [URLTargeting](./foundation-filters.urltargeting.md) \| [UserAgent](./foundation-filters.useragent.md) \| [UserTargeting](./foundation-filters.usertargeting.md)
+

package/docs/api/foundation-filters.logger.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [logger](./foundation-filters.logger.md)
+
+## logger variable
+
+Client filter logger
+
+**Signature:**
+
+```typescript
+logger: import("@genesislcap/foundation-utils").Logger
+```
+
+## Remarks
+
+Exposed so that the logging level within this package can be tailored differently to the default level when needed.
+
+## Example
+
+
+```ts
+import { LogLevel } from '@genesislcap/foundation-utils';
+import { logger as clientFilterLogger } from '@genesislcap/foundation-filters';
+clientFilterLogger.level = LogLevel.Error;
+```
+

package/docs/api/foundation-filters.md

@@ -0,0 +1,71 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md)
+
+## foundation-filters package
+
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [DefaultClientFilterRunner](./foundation-filters.defaultclientfilterrunner.md) | Default ClientFilterRunner DI implementation. |
+|  [DefaultNodeEnv](./foundation-filters.defaultnodeenv.md) | Default NodeEnv DI implementation. |
+|  [DefaultPercentage](./foundation-filters.defaultpercentage.md) | Default Percentage DI implementation. |
+|  [DefaultTimeWindow](./foundation-filters.defaulttimewindow.md) | Default TimeWindow DI implementation. |
+|  [DefaultURLTargeting](./foundation-filters.defaulturltargeting.md) | Default URLTargeting DI implementation. |
+|  [DefaultUserAgent](./foundation-filters.defaultuseragent.md) | Default UserAgent DI implementation. |
+|  [DefaultUserTargeting](./foundation-filters.defaultusertargeting.md) | Default UserTargeting DI implementation. |
+
+## Functions
+
+|  Function | Description |
+|  --- | --- |
+|  [getFilterByName(name, container)](./foundation-filters.getfilterbyname.md) | Filer lookup by name. |
+|  [nodeEnvFilter(envs)](./foundation-filters.nodeenvfilter.md) | NodeEnv client filter function. |
+|  [percentageFilter(percent, random)](./foundation-filters.percentagefilter.md) | Percentage client filter function. |
+|  [runner(filters, container)](./foundation-filters.runner.md) | Client filter runner function. |
+|  [timeWindowFilter(start, end)](./foundation-filters.timewindowfilter.md) | TimeWindow client filter function. |
+|  [urlTargetingFilter(url, pattern, schemes, hosts, paths)](./foundation-filters.urltargetingfilter.md) | URLTargeting client filter function. |
+|  [userAgentFilter(browsers, devices, oss, ua)](./foundation-filters.useragentfilter.md) | UserAgent client filter function. |
+|  [userTargetingFilter(user, usernames, profiles, permissions)](./foundation-filters.usertargetingfilter.md) | UserTargeting client filter function. |
+
+## Interfaces
+
+|  Interface | Description |
+|  --- | --- |
+|  [ClientFilter](./foundation-filters.clientfilter.md) | ClientFilter interface. |
+|  [ClientFilterRunner](./foundation-filters.clientfilterrunner.md) | ClientFilterRunner DI interface. |
+|  [NodeEnv](./foundation-filters.nodeenv.md) | NodeEnv client filter DI interface. |
+|  [Percentage](./foundation-filters.percentage.md) | Percentage client filter DI interface. |
+|  [TimeWindow](./foundation-filters.timewindow.md) | TimeWindow client filter DI interface. |
+|  [URLTargeting](./foundation-filters.urltargeting.md) | URLTargeting client filter DI interface. |
+|  [UserAgent](./foundation-filters.useragent.md) | UserAgent client filter DI interface. |
+|  [UserTargeting](./foundation-filters.usertargeting.md) | UserTargeting client filter DI interface. |
+
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [ClientFilterName](./foundation-filters.clientfiltername.md) |  |
+|  [logger](./foundation-filters.logger.md) | Client filter logger |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [ClientFilterName](./foundation-filters.clientfiltername.md) |  |
+|  [ClientFilterSchema](./foundation-filters.clientfilterschema.md) | ClientFilterSchema type. |
+|  [ClientFilterSchemas](./foundation-filters.clientfilterschemas.md) | ClientFilterSchemas type. |
+|  [NodeEnvParams](./foundation-filters.nodeenvparams.md) | NodeEnvParams |
+|  [NodeEnvSchema](./foundation-filters.nodeenvschema.md) | NodeEnvSchema type. |
+|  [PercentageParams](./foundation-filters.percentageparams.md) | PercentageParams |
+|  [PercentageSchema](./foundation-filters.percentageschema.md) | PercentageSchema type. |
+|  [TimeWindowParams](./foundation-filters.timewindowparams.md) | TimeWindowParams |
+|  [TimeWindowSchema](./foundation-filters.timewindowschema.md) | TimeWindowSchema type. |
+|  [URLTargetingParams](./foundation-filters.urltargetingparams.md) | URLTargetingParams |
+|  [URLTargetingSchema](./foundation-filters.urltargetingschema.md) | URLTargetingSchema type. |
+|  [UserAgentParams](./foundation-filters.useragentparams.md) | UserAgentParams |
+|  [UserAgentSchema](./foundation-filters.useragentschema.md) | UserAgentSchema type. |
+|  [UserTargetingParams](./foundation-filters.usertargetingparams.md) | UserTargetingParams |
+|  [UserTargetingSchema](./foundation-filters.usertargetingschema.md) | UserTargetingSchema type. |
+

package/docs/api/foundation-filters.nodeenv.isdevelopment.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnv](./foundation-filters.nodeenv.md) &gt; [isDevelopment](./foundation-filters.nodeenv.isdevelopment.md)
+
+## NodeEnv.isDevelopment property
+
+**Signature:**
+
+```typescript
+readonly isDevelopment: boolean;
+```
+
+## Remarks
+
+Running in development mode.
+

package/docs/api/foundation-filters.nodeenv.isproduction.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnv](./foundation-filters.nodeenv.md) &gt; [isProduction](./foundation-filters.nodeenv.isproduction.md)
+
+## NodeEnv.isProduction property
+
+**Signature:**
+
+```typescript
+readonly isProduction: boolean;
+```
+
+## Remarks
+
+Running in production mode.
+

package/docs/api/foundation-filters.nodeenv.istesting.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnv](./foundation-filters.nodeenv.md) &gt; [isTesting](./foundation-filters.nodeenv.istesting.md)
+
+## NodeEnv.isTesting property
+
+**Signature:**
+
+```typescript
+readonly isTesting: boolean;
+```
+
+## Remarks
+
+Running in test mode.
+

package/docs/api/foundation-filters.nodeenv.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnv](./foundation-filters.nodeenv.md)
+
+## NodeEnv interface
+
+NodeEnv client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface NodeEnv extends ClientFilter<NodeEnvParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[NodeEnvParams](./foundation-filters.nodeenvparams.md)<!-- -->&gt;
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isDevelopment](./foundation-filters.nodeenv.isdevelopment.md) | <code>readonly</code> | boolean |  |
+|  [isProduction](./foundation-filters.nodeenv.isproduction.md) | <code>readonly</code> | boolean |  |
+|  [isTesting](./foundation-filters.nodeenv.istesting.md) | <code>readonly</code> | boolean |  |
+

package/docs/api/foundation-filters.nodeenvfilter.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [nodeEnvFilter](./foundation-filters.nodeenvfilter.md)
+
+## nodeEnvFilter() function
+
+NodeEnv client filter function.
+
+**Signature:**
+
+```typescript
+export declare function nodeEnvFilter(envs: string[]): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  envs | string\[\] | Environments to target. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true when the current node env matches target parameters.
+

package/docs/api/foundation-filters.nodeenvparams.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnvParams](./foundation-filters.nodeenvparams.md)
+
+## NodeEnvParams type
+
+NodeEnvParams
+
+**Signature:**
+
+```typescript
+export type NodeEnvParams = {
+    readonly envs: string[];
+};
+```
+
+## Example
+
+
+```json
+{
+   "envs": ["development", "testing"],
+}
+```
+

package/docs/api/foundation-filters.nodeenvschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [NodeEnvSchema](./foundation-filters.nodeenvschema.md)
+
+## NodeEnvSchema type
+
+NodeEnvSchema type.
+
+**Signature:**
+
+```typescript
+export type NodeEnvSchema = ClientFilterSchema<typeof ClientFilterName.nodeEnv, NodeEnvParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [NodeEnvParams](./foundation-filters.nodeenvparams.md)
+
+## Remarks
+
+JSON schema type.
+

package/docs/api/foundation-filters.percentage.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [Percentage](./foundation-filters.percentage.md)
+
+## Percentage interface
+
+Percentage client filter DI interface.
+
+**Signature:**
+
+```typescript
+export interface Percentage extends ClientFilter<PercentageParams> 
+```
+**Extends:** [ClientFilter](./foundation-filters.clientfilter.md)<!-- -->&lt;[PercentageParams](./foundation-filters.percentageparams.md)<!-- -->&gt;
+
+## Remarks
+
+Simplifies access to runtime data / state contained within the DI container.
+

package/docs/api/foundation-filters.percentagefilter.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [percentageFilter](./foundation-filters.percentagefilter.md)
+
+## percentageFilter() function
+
+Percentage client filter function.
+
+**Signature:**
+
+```typescript
+export declare function percentageFilter(percent: number, random?: number): boolean;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  percent | number | The percent of the time to pass, a numeric value between 0 and 1. |
+|  random | number | _(Optional)_ Math.random() generated floating-point. |
+
+**Returns:**
+
+boolean
+
+## Remarks
+
+This will return true a certain percentage of the time.
+

package/docs/api/foundation-filters.percentageparams.md

@@ -0,0 +1,41 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [PercentageParams](./foundation-filters.percentageparams.md)
+
+## PercentageParams type
+
+PercentageParams
+
+**Signature:**
+
+```typescript
+export type PercentageParams = {
+    readonly percent: number;
+    readonly random?: number;
+};
+```
+
+## Remarks
+
+Percent should be a numeric value between 0 and 1.
+
+## Example 1
+
+
+```json
+{
+   "percent": 0.5
+}
+```
+
+## Example 2
+
+In a rare case where you need to control the random floating-point creation, you can do so externally and provide it.
+
+```json
+{
+   "percent": 0.34
+   "random": 0.08901819974272063
+}
+```
+

package/docs/api/foundation-filters.percentageschema.md

@@ -0,0 +1,19 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-filters](./foundation-filters.md) &gt; [PercentageSchema](./foundation-filters.percentageschema.md)
+
+## PercentageSchema type
+
+PercentageSchema type.
+
+**Signature:**
+
+```typescript
+export type PercentageSchema = ClientFilterSchema<typeof ClientFilterName.percentage, PercentageParams>;
+```
+**References:** [ClientFilterSchema](./foundation-filters.clientfilterschema.md)<!-- -->, [PercentageParams](./foundation-filters.percentageparams.md)
+
+## Remarks
+
+JSON schema type.
+