Skip to content

docs(api): regenerate the API reference pages #175

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rennf93 merged 1 commit into from
Oct 20, 2026
Merged

docs(api): regenerate the API reference pages #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
668 changes: 646 additions & 22 deletions docs/src/content/docs/api/core/src/classes/BaseSecurityDecorator.md
View file
Open in desktop

Large diffs are not rendered by default.

42 changes: 33 additions & 9 deletions docs/src/content/docs/api/core/src/classes/BehaviorRule.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ prev: false
title: "BehaviorRule"
---

Defined in: [core/src/models/behavior-rule.ts:4](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L4)
Defined in: [packages/core/src/models/behavior-rule.ts:4](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L4)

## Constructors

### Constructor

> **new BehaviorRule**(`ruleType`, `threshold`, `window?`, `pattern?`, `action?`, `customAction?`): `BehaviorRule`
> **new BehaviorRule**(`ruleType`, `threshold`, `window?`, `pattern?`, `action?`, `customAction?`, `banDuration?`, `correlateWithDetection?`): `BehaviorRule`

Defined in: [core/src/models/behavior-rule.ts:12](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L12)
Defined in: [packages/core/src/models/behavior-rule.ts:19](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L19)

#### Parameters

Expand Down Expand Up @@ -41,6 +41,14 @@ Defined in: [core/src/models/behavior-rule.ts:12](https://github.com/Guard-Core/

((...`args`) => `unknown`) \| `null`

##### banDuration?

`number` \| `null`

##### correlateWithDetection?

`boolean` = `false`

#### Returns

`BehaviorRule`
Expand All @@ -51,44 +59,60 @@ Defined in: [core/src/models/behavior-rule.ts:12](https://github.com/Guard-Core/

> `readonly` **action**: [`BehaviorAction`](/guard-core-ts/api/core/src/type-aliases/behavioraction/)

Defined in: [core/src/models/behavior-rule.ts:9](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L9)
Defined in: [packages/core/src/models/behavior-rule.ts:9](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L9)

***

### banDuration

> `readonly` **banDuration**: `number` \| `null`

Defined in: [packages/core/src/models/behavior-rule.ts:13](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L13)

***

### correlateWithDetection

> `readonly` **correlateWithDetection**: `boolean`

Defined in: [packages/core/src/models/behavior-rule.ts:17](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L17)

***

### customAction

> `readonly` **customAction**: ((...`args`) => `unknown`) \| `null`

Defined in: [core/src/models/behavior-rule.ts:10](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L10)
Defined in: [packages/core/src/models/behavior-rule.ts:10](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L10)

***

### pattern

> `readonly` **pattern**: `string` \| `null`

Defined in: [core/src/models/behavior-rule.ts:8](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L8)
Defined in: [packages/core/src/models/behavior-rule.ts:8](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L8)

***

### ruleType

> `readonly` **ruleType**: [`BehaviorRuleType`](/guard-core-ts/api/core/src/type-aliases/behaviorruletype/)

Defined in: [core/src/models/behavior-rule.ts:5](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L5)
Defined in: [packages/core/src/models/behavior-rule.ts:5](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L5)

***

### threshold

> `readonly` **threshold**: `number`

Defined in: [core/src/models/behavior-rule.ts:6](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L6)
Defined in: [packages/core/src/models/behavior-rule.ts:6](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L6)

***

### window

> `readonly` **window**: `number`

Defined in: [core/src/models/behavior-rule.ts:7](https://github.com/Guard-Core/guard-core-ts/blob/b49ed8cdbf992765ff7882327eaf5f8a9461242e/packages/core/src/models/behavior-rule.ts#L7)
Defined in: [packages/core/src/models/behavior-rule.ts:7](https://github.com/Guard-Core/guard-core-ts/blob/772db2916717516ad477ac515f458b80fb9ccaba/packages/core/src/models/behavior-rule.ts#L7)
Loading
Loading