@genesislcap/foundation-auth 14.136.0 → 14.137.0

package/docs/api/foundation-auth.defaultuserconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [defaultUserConfig](./foundation-auth.defaultuserconfig.md)
-
-## defaultUserConfig variable
-
-Default UserConfig DI implementation.
-
-**Signature:**
-
-```typescript
-defaultUserConfig: UserConfig
-```

package/docs/api/foundation-auth.details.daystopasswordexpiry.md

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

package/docs/api/foundation-auth.details.failedloginattempts.md

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

package/docs/api/foundation-auth.details.heartbeatintervalsecs.md

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

package/docs/api/foundation-auth.details.lastlogindatetime.md

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

package/docs/api/foundation-auth.details.product.md

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

package/docs/api/foundation-auth.details.rejectedloginattempts.md

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

package/docs/api/foundation-auth.details.system.md

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

package/docs/api/foundation-auth.getuser.md

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [getUser](./foundation-auth.getuser.md)
-
-## getUser() function
-
-Gets User from the DI container.
-
-**Signature:**
-
-```typescript
-export declare function getUser(): User;
-```
-**Returns:**
-
-[User](./foundation-auth.user.md)
-
-## Remarks
-
-A utility method for host applications that are not using decorators or the DI container.
-
-## Example
-
-
-```ts
-import { getUser, User } from '@genesislcap/foundation-auth/user';
-...
-private user: User = getUser();
-```
-

package/docs/api/foundation-auth.loginack.details.md

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

package/docs/api/foundation-auth.loginack.permission.md

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

package/docs/api/foundation-auth.loginack.profile.md

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

package/docs/api/foundation-auth.loginack.updatequeue.md

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

package/docs/api/foundation-auth.loginack.userkvs.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [LoginAck](./foundation-auth.loginack.md) &gt; [userKVs](./foundation-auth.loginack.userkvs.md)
-
-## LoginAck.userKVs property
-
-**Signature:**
-
-```typescript
-readonly userKVs: {
-        [key: string]: any;
-    };
-```

package/docs/api/foundation-auth.loginack.username.md

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

package/docs/api/foundation-auth.loginack.zeromqproxyinboundport.md

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

package/docs/api/foundation-auth.loginack.zeromqproxymodeenabled.md

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

package/docs/api/foundation-auth.loginack.zeromqproxyoutboundport.md

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

package/docs/api/foundation-auth.product.name.md

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

package/docs/api/foundation-auth.product.version.md

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

package/docs/api/foundation-auth.system.date.md

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

package/docs/api/foundation-auth.user.addauthenticationchangelistener.md

@@ -1,33 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [addAuthenticationChangeListener](./foundation-auth.user.addauthenticationchangelistener.md)
-
-## User.addAuthenticationChangeListener() method
-
-**Signature:**
-
-```typescript
-addAuthenticationChangeListener(listener: Listener<UserAuthenticationChangeEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[UserAuthenticationChangeEvent](./foundation-auth.userauthenticationchangeevent.md)<!-- -->&gt; | A listener function. |
-
-**Returns:**
-
-() =&gt; void
-
-## Example
-
-
-```ts
-import type { UserAuthenticationChangeEvent } from '@genesislcap/foundation-auth/user';
-...
-const unsubscribe = this.user.addAuthenticationChangeListener((event: UserAuthenticationChangeEvent) => {
-  console.log('User authenticated?', event.detail);
-});
-```
-

package/docs/api/foundation-auth.user.cleartrackinghistory.md

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

package/docs/api/foundation-auth.user.details.md

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

package/docs/api/foundation-auth.user.haspermission.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [hasPermission](./foundation-auth.user.haspermission.md)
-
-## User.hasPermission() method
-
-**Signature:**
-
-```typescript
-hasPermission(permission: string | string[]): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  permission | string \| string\[\] | A permission string or an array of permission strings to check. |
-
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.user.hasprofile.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [hasProfile](./foundation-auth.user.hasprofile.md)
-
-## User.hasProfile() method
-
-**Signature:**
-
-```typescript
-hasProfile(profile: string | string[]): boolean;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  profile | string \| string\[\] | A profile string or an array of profile strings to check. |
-
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.user.isadmin.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [isAdmin](./foundation-auth.user.isadmin.md)
-
-## User.isAdmin() method
-
-**Signature:**
-
-```typescript
-isAdmin(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.user.isanonymous.md

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

package/docs/api/foundation-auth.user.isauthenticated.md

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

package/docs/api/foundation-auth.user.isbanned.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [isBanned](./foundation-auth.user.isbanned.md)
-
-## User.isBanned() method
-
-**Signature:**
-
-```typescript
-isBanned(): boolean;
-```
-**Returns:**
-
-boolean
-

package/docs/api/foundation-auth.user.md

@@ -1,55 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md)
-
-## User interface
-
-User interface.
-
-**Signature:**
-
-```typescript
-export interface User extends UserPathHistory, UserActionHistory 
-```
-**Extends:** [UserPathHistory](./foundation-auth.userpathhistory.md)<!-- -->, [UserActionHistory](./foundation-auth.useractionhistory.md)
-
-## Remarks
-
-The user singleton, which always exists in either an anonymous or authenticated mode.
-
-## Example
-
-
-```ts
-import { User } from '@genesislcap/foundation-auth/user';
-...
-@User private user: User
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [details](./foundation-auth.user.details.md) | <code>readonly</code> | [Details](./foundation-auth.details.md) |  |
-|  [isAnonymous](./foundation-auth.user.isanonymous.md) | <code>readonly</code> | boolean |  |
-|  [isAuthenticated](./foundation-auth.user.isauthenticated.md) | <code>readonly</code> | boolean |  |
-|  [permission](./foundation-auth.user.permission.md) | <code>readonly</code> | string\[\] |  |
-|  [profile](./foundation-auth.user.profile.md) | <code>readonly</code> | string\[\] |  |
-|  [sourceRef](./foundation-auth.user.sourceref.md) | <code>readonly</code> | string |  |
-|  [userKVs](./foundation-auth.user.userkvs.md) | <code>readonly</code> | { \[key: string\]: any; } |  |
-|  [username](./foundation-auth.user.username.md) | <code>readonly</code> | string |  |
-|  [userName](./foundation-auth.user.username.md) | <code>readonly</code> | string |  |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [addAuthenticationChangeListener(listener)](./foundation-auth.user.addauthenticationchangelistener.md) |  |
-|  [clearTrackingHistory()](./foundation-auth.user.cleartrackinghistory.md) |  |
-|  [hasPermission(permission)](./foundation-auth.user.haspermission.md) |  |
-|  [hasProfile(profile)](./foundation-auth.user.hasprofile.md) |  |
-|  [isAdmin()](./foundation-auth.user.isadmin.md) |  |
-|  [isBanned()](./foundation-auth.user.isbanned.md) |  |
-|  [set(entity)](./foundation-auth.user.set.md) |  |
-|  [unset()](./foundation-auth.user.unset.md) |  |
-

package/docs/api/foundation-auth.user.permission.md

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

package/docs/api/foundation-auth.user.profile.md

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

package/docs/api/foundation-auth.user.set.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [set](./foundation-auth.user.set.md)
-
-## User.set() method
-
-**Signature:**
-
-```typescript
-set(entity: Partial<LoginAck>): this;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  entity | Partial&lt;[LoginAck](./foundation-auth.loginack.md)<!-- -->&gt; | The LoginAck used to populate the User. |
-
-**Returns:**
-
-this
-

package/docs/api/foundation-auth.user.sourceref.md

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

package/docs/api/foundation-auth.user.unset.md

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

package/docs/api/foundation-auth.user.userkvs.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [User](./foundation-auth.user.md) &gt; [userKVs](./foundation-auth.user.userkvs.md)
-
-## User.userKVs property
-
-**Signature:**
-
-```typescript
-readonly userKVs: {
-        [key: string]: any;
-    };
-```

package/docs/api/foundation-auth.user.username.md

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

package/docs/api/foundation-auth.useractionhistory.actionhistory.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserActionHistory](./foundation-auth.useractionhistory.md) &gt; [actionHistory](./foundation-auth.useractionhistory.actionhistory.md)
-
-## UserActionHistory.actionHistory property
-
-Array of actions that have been tracked.
-
-**Signature:**
-
-```typescript
-readonly actionHistory: unknown[];
-```

package/docs/api/foundation-auth.useractionhistory.clearactions.md

@@ -1,17 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-auth](./foundation-auth.md) &gt; [UserActionHistory](./foundation-auth.useractionhistory.md) &gt; [clearActions](./foundation-auth.useractionhistory.clearactions.md)
-
-## UserActionHistory.clearActions() method
-
-Clears action history.
-
-**Signature:**
-
-```typescript
-clearActions(): void;
-```
-**Returns:**
-
-void
-