diff --git a/.github/CONTRIBUTING.MD b/.github/CONTRIBUTING.MD
index 6d2c55a40f..56719bd929 100644
--- a/.github/CONTRIBUTING.MD
+++ b/.github/CONTRIBUTING.MD
@@ -38,7 +38,7 @@ You can also run the tests of only one package by going to its directory and run
### General guidelines
-Do not install any new dependencies unless they have been approved.
+Do not install any new dependencies unless they have been approved. Dependencies (except peer ones) should point to *minor* versions (`~1.2.0` instead of `^1.2.0`).
When writting code, use the *Test-Driven Developpement (TDD)* approach.
1. Write a test.
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 6d499c8128..51d6e927b0 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -11,6 +11,52 @@ jobs:
matrix:
node-version: [8.x, 10.x]
+ env:
+ AUTH0_DOMAIN: ${{ secrets.AUTH0_DOMAIN }}
+ AUTH0_AUDIENCE: ${{ secrets.AUTH0_AUDIENCE }}
+ AUTH0_TOKEN: ${{ secrets.AUTH0_TOKEN }}
+
+ services:
+ mysql:
+ image: mysql:5.7.10
+ ports:
+ # Another version of MySQL is installed on the vm and already uses the port 3306.
+ - 3308:3306
+ env:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_USER: test
+ MYSQL_PASSWORD: test
+ MYSQL_DATABASE: test
+
+ mariadb:
+ image: mariadb:10.1.16
+ ports:
+ - 3307:3306
+ env:
+ MYSQL_ROOT_PASSWORD: admin
+ MYSQL_USER: test
+ MYSQL_PASSWORD: test
+ MYSQL_DATABASE: test
+
+ postgres:
+ image: postgres:9.6.1
+ ports:
+ - 5432:5432
+ env:
+ POSTGRES_USER: test
+ POSTGRES_PASSWORD: test
+ POSTGRES_DB: test
+
+ mongodb:
+ image: mongo:3.4.1
+ ports:
+ - 27017:27017
+
+ redis:
+ image: redis:4.0.14
+ ports:
+ - 6379:6379
+
steps:
- uses: actions/checkout@v1
- name: Use Node.js ${{ matrix.node-version }}
@@ -22,12 +68,18 @@ jobs:
- name: Install project dependencies
run: npm install
- name: Install package dependencies and build packages
- run: |
- lerna bootstrap
- cd packages/cli && npm link && cd ../..
+ run: lerna bootstrap
+ - name: Create CLI symlink in the global folder
+ run: npm link
+ working-directory: packages/cli
- name: Check package linting
run: npm run lint
- name: Run unit and acceptance tests (TypeScript)
run: lerna run --no-bail test
- name: Run acceptance tests (Bash)
run: ./e2e_test.sh
+ - name: Send code coverage report to Codecov
+ uses: codecov/codecov-action@v1.0.3
+ with:
+ token: ${{secrets.CODECOV_TOKEN}}
+ file: packages/core/coverage/*.json
diff --git a/.travis.yml b/.travis.yml
deleted file mode 100644
index f6f5cf56ce..0000000000
--- a/.travis.yml
+++ /dev/null
@@ -1,31 +0,0 @@
-sudo: required
-language: node_js
-node_js:
- - 10
- - 8
-
-services:
- - docker
-
-before_script:
- - sudo service mysql stop
- - sudo service postgresql stop
- - docker-compose up -d
-
-before_install:
- - npm install -g lerna
- - npm install -g pm2
- - npm install -g codecov
-
-install:
- - npm install
- - lerna bootstrap
- - cd packages/cli && npm link && cd ../..
-
-script:
- - npm run lint
- - lerna run --no-bail test
- - ./e2e_test.sh
-
-after_success:
- - codecov -f packages/core/coverage/*.json
\ No newline at end of file
diff --git a/README.md b/README.md
index 73ce9759bf..77755406ce 100644
--- a/README.md
+++ b/README.md
@@ -16,8 +16,8 @@
-
-
+
+
diff --git a/docker-compose.yml b/docker-compose.yml
index da6af4bd72..0a8fab8d97 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -4,7 +4,8 @@ services:
mysql:
image: "mysql:5.7.10"
ports:
- - "3306:3306"
+ # Another version of MySQL is installed on the vm and already uses the port 3306.
+ - "3308:3306"
environment:
MYSQL_ROOT_PASSWORD: "admin"
MYSQL_USER: "test"
diff --git a/docs/README.md b/docs/README.md
index 1c49ffc7f4..b3c92a7c0f 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,7 +1,7 @@
![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)
![node version](https://img.shields.io/badge/node-%3E%3D8-brightgreen.svg)
![npm version](https://badge.fury.io/js/%40foal%2Fcore.svg)
-![Build Status](https://travis-ci.org/FoalTS/foal.svg?branch=add-travis)
+[![Actions Status](https://github.com/FoalTS/foal/workflows/Test/badge.svg)](https://github.com/FoalTS/foal/actions)
![Code coverage](https://codecov.io/gh/FoalTS/foal/branch/master/graphs/badge.svg)
![Known Vulnerabilities](https://snyk.io/test/github/foalts/foal/badge.svg)
![Commit activity](https://img.shields.io/github/commit-activity/y/FoalTS/foal.svg)
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 0fc483a460..8ed5e2b26d 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -48,6 +48,7 @@
* [Passwords](./authentication-and-access-control/password-management.md)
* [Session Tokens (authentication)](./authentication-and-access-control/session-tokens.md)
* [JSON Web Tokens (authentication)](./authentication-and-access-control/jwt.md)
+ * [Social Auth](./authentication-and-access-control/social-auth.md)
* [Administrators & Roles](./authentication-and-access-control/administrators-and-roles.md)
* [Groups & Permissions](./authentication-and-access-control/groups-and-permissions.md)
* [Validation & Sanitization](./validation-and-sanitization.md)
diff --git a/docs/api/core/classes/_common_errors_object_does_not_exist_.objectdoesnotexist.md b/docs/api/core/classes/_common_errors_object_does_not_exist_.objectdoesnotexist.md
index d4e216f230..d348fbcba9 100644
--- a/docs/api/core/classes/_common_errors_object_does_not_exist_.objectdoesnotexist.md
+++ b/docs/api/core/classes/_common_errors_object_does_not_exist_.objectdoesnotexist.md
@@ -41,7 +41,7 @@ Represent an object that was expected to be found but that does not exist.
⊕ **new ObjectDoesNotExist**(content?: *`any`*): [ObjectDoesNotExist](_common_errors_object_does_not_exist_.objectdoesnotexist.md)
-*Defined in [common/errors/object-does-not-exist.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L9)*
+*Defined in [common/errors/object-does-not-exist.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/object-does-not-exist.ts#L9)*
**Parameters:**
@@ -61,7 +61,7 @@ ___
**● content**: *`any`*
-*Defined in [common/errors/object-does-not-exist.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L11)*
+*Defined in [common/errors/object-does-not-exist.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/object-does-not-exist.ts#L11)*
___
@@ -70,7 +70,7 @@ ___
**● isObjectDoesNotExist**: *`true`* = true
-*Defined in [common/errors/object-does-not-exist.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L9)*
+*Defined in [common/errors/object-does-not-exist.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/object-does-not-exist.ts#L9)*
___
diff --git a/docs/api/core/classes/_common_errors_permission_denied_.permissiondenied.md b/docs/api/core/classes/_common_errors_permission_denied_.permissiondenied.md
index af3c8c8874..0b78b74909 100644
--- a/docs/api/core/classes/_common_errors_permission_denied_.permissiondenied.md
+++ b/docs/api/core/classes/_common_errors_permission_denied_.permissiondenied.md
@@ -41,7 +41,7 @@ Represent the prohibition to perform an action that was expected to be accessibl
⊕ **new PermissionDenied**(content?: *`any`*): [PermissionDenied](_common_errors_permission_denied_.permissiondenied.md)
-*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L9)*
+*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/permission-denied.ts#L9)*
**Parameters:**
@@ -61,7 +61,7 @@ ___
**● content**: *`any`*
-*Defined in [common/errors/permission-denied.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L11)*
+*Defined in [common/errors/permission-denied.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/permission-denied.ts#L11)*
___
@@ -70,7 +70,7 @@ ___
**● isPermissionDenied**: *`true`* = true
-*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L9)*
+*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/permission-denied.ts#L9)*
___
diff --git a/docs/api/core/classes/_common_errors_validation_error_.validationerror.md b/docs/api/core/classes/_common_errors_validation_error_.validationerror.md
index 0dda0adcd0..330b230d46 100644
--- a/docs/api/core/classes/_common_errors_validation_error_.validationerror.md
+++ b/docs/api/core/classes/_common_errors_validation_error_.validationerror.md
@@ -41,7 +41,7 @@ Represent an incorrect data format.
⊕ **new ValidationError**(content?: *`any`*): [ValidationError](_common_errors_validation_error_.validationerror.md)
-*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L9)*
+*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/validation-error.ts#L9)*
**Parameters:**
@@ -61,7 +61,7 @@ ___
**● content**: *`any`*
-*Defined in [common/errors/validation-error.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L11)*
+*Defined in [common/errors/validation-error.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/validation-error.ts#L11)*
___
@@ -70,7 +70,7 @@ ___
**● isValidationError**: *`true`* = true
-*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L9)*
+*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/validation-error.ts#L9)*
___
diff --git a/docs/api/core/classes/_core_config_.config.md b/docs/api/core/classes/_core_config_.config.md
index 0d7c2a3ba7..c24ebde407 100644
--- a/docs/api/core/classes/_core_config_.config.md
+++ b/docs/api/core/classes/_core_config_.config.md
@@ -51,7 +51,7 @@ This class can also be used as a service.
**● yaml**: *`any`*
-*Defined in [core/config.ts:91](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L91)*
+*Defined in [core/config.ts:91](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L91)*
___
@@ -63,7 +63,7 @@ ___
▸ **get**<`T`>(key: *`string`*, defaultValue?: *[T]()*): `T`
-*Defined in [core/config.ts:225](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L225)*
+*Defined in [core/config.ts:225](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L225)*
Access environment variables and configuration files.
@@ -102,7 +102,7 @@ ___
▸ **clearCache**(): `void`
-*Defined in [core/config.ts:83](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L83)*
+*Defined in [core/config.ts:83](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L83)*
Clear the cache of the loaded files.
@@ -119,7 +119,7 @@ ___
▸ **convertType**(value: *`string`*): `boolean` \| `number` \| `string`
-*Defined in [core/config.ts:172](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L172)*
+*Defined in [core/config.ts:172](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L172)*
**Parameters:**
@@ -136,7 +136,7 @@ ___
▸ **dotToUnderscore**(str: *`string`*): `string`
-*Defined in [core/config.ts:165](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L165)*
+*Defined in [core/config.ts:165](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L165)*
**Parameters:**
@@ -153,7 +153,7 @@ ___
▸ **get**<`T`>(key: *`string`*, defaultValue?: *[T]()*): `T`
-*Defined in [core/config.ts:39](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L39)*
+*Defined in [core/config.ts:39](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L39)*
Access environment variables and configuration files.
@@ -194,7 +194,7 @@ ___
▸ **getValue**(config: *`object`*, propertyPath: *`string`*): `any`
-*Defined in [core/config.ts:189](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L189)*
+*Defined in [core/config.ts:189](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L189)*
**Parameters:**
@@ -212,7 +212,7 @@ ___
▸ **getYAMLInstance**(): `false` \| `any`
-*Defined in [core/config.ts:150](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L150)*
+*Defined in [core/config.ts:150](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L150)*
**Returns:** `false` \| `any`
@@ -223,7 +223,7 @@ ___
▸ **readDotEnvValue**(name: *`string`*): `string` \| `boolean` \| `number` \| `undefined`
-*Defined in [core/config.ts:98](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L98)*
+*Defined in [core/config.ts:98](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L98)*
**Parameters:**
@@ -240,7 +240,7 @@ ___
▸ **readJSONValue**(path: *`string`*, key: *`string`*): `any`
-*Defined in [core/config.ts:118](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L118)*
+*Defined in [core/config.ts:118](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L118)*
**Parameters:**
@@ -258,7 +258,7 @@ ___
▸ **readYAMLValue**(path: *`string`*, key: *`string`*): `any`
-*Defined in [core/config.ts:131](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L131)*
+*Defined in [core/config.ts:131](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L131)*
**Parameters:**
@@ -279,7 +279,7 @@ ___
**cache**: *`object`*
-*Defined in [core/config.ts:92](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L92)*
+*Defined in [core/config.ts:92](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L92)*
@@ -287,7 +287,7 @@ ___
**● dotEnv**: *`undefined`* = undefined
-*Defined in [core/config.ts:93](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L93)*
+*Defined in [core/config.ts:93](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L93)*
___
@@ -296,7 +296,7 @@ ___
**● json**: *`object`*
-*Defined in [core/config.ts:94](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L94)*
+*Defined in [core/config.ts:94](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L94)*
#### Type declaration
@@ -307,7 +307,7 @@ ___
**● yaml**: *`object`*
-*Defined in [core/config.ts:95](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L95)*
+*Defined in [core/config.ts:95](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config.ts#L95)*
#### Type declaration
diff --git a/docs/api/core/classes/_core_config_mock_.configmock.md b/docs/api/core/classes/_core_config_mock_.configmock.md
index a1d7048565..96fbaa286a 100644
--- a/docs/api/core/classes/_core_config_mock_.configmock.md
+++ b/docs/api/core/classes/_core_config_mock_.configmock.md
@@ -40,7 +40,7 @@ Mock the Config class when it is used as a service.
**● map**: *`Map`<`string`, `any`>* = new Map()
-*Defined in [core/config-mock.ts:12](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L12)*
+*Defined in [core/config-mock.ts:12](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config-mock.ts#L12)*
___
@@ -52,7 +52,7 @@ ___
▸ **get**<`T`>(key: *`string`*, defaultValue?: *`T` \| `undefined`*): `T`
-*Defined in [core/config-mock.ts:34](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L34)*
+*Defined in [core/config-mock.ts:34](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config-mock.ts#L34)*
Return the config value previously given with ConfigMock.set.
@@ -80,7 +80,7 @@ ___
▸ **reset**(): `void`
-*Defined in [core/config-mock.ts:43](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L43)*
+*Defined in [core/config-mock.ts:43](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config-mock.ts#L43)*
Clear every config value previously given with Config.set.
@@ -95,7 +95,7 @@ ___
▸ **set**(key: *`string`*, value: *`any`*): `void`
-*Defined in [core/config-mock.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L21)*
+*Defined in [core/config-mock.ts:21](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/config-mock.ts#L21)*
Set an configuration variable.
diff --git a/docs/api/core/classes/_core_http_contexts_.context.md b/docs/api/core/classes/_core_http_contexts_.context.md
index 0dffa439b9..bfda25930b 100644
--- a/docs/api/core/classes/_core_http_contexts_.context.md
+++ b/docs/api/core/classes/_core_http_contexts_.context.md
@@ -45,7 +45,7 @@ Class instantiated on each request. It includes:
⊕ **new Context**(request: *`any`*): [Context](_core_http_contexts_.context.md)
-*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L19)*
+*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/contexts.ts#L19)*
Creates an instance of Context.
@@ -69,7 +69,7 @@ ___
**● request**: *`Request`*
-*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L19)*
+*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/contexts.ts#L19)*
___
@@ -78,7 +78,7 @@ ___
**● session**: *`ContextSession`*
-*Defined in [core/http/contexts.ts:18](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L18)*
+*Defined in [core/http/contexts.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/contexts.ts#L18)*
___
@@ -87,7 +87,7 @@ ___
**● state**: *`object`*
-*Defined in [core/http/contexts.ts:16](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L16)*
+*Defined in [core/http/contexts.ts:16](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/contexts.ts#L16)*
#### Type declaration
@@ -100,7 +100,7 @@ ___
**● user**: *`User`*
-*Defined in [core/http/contexts.ts:17](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L17)*
+*Defined in [core/http/contexts.ts:17](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/contexts.ts#L17)*
___
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponse.md b/docs/api/core/classes/_core_http_http_responses_.httpresponse.md
index 36a8fb58db..45bdce663a 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponse.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponse.md
@@ -57,7 +57,7 @@ Reprensent an HTTP response. This class must be extended. Instances of HttpRespo
⊕ **new HttpResponse**(body?: *`any`*, options?: *`object`*): [HttpResponse](_core_http_http_responses_.httpresponse.md)
-*Defined in [core/http/http-responses.ts:70](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L70)*
+*Defined in [core/http/http-responses.ts:70](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L70)*
Create an instance of HttpResponse.
@@ -85,7 +85,7 @@ ___
**● body**: *`any`*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
**● cookies**: *`object`*
-*Defined in [core/http/http-responses.ts:69](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L69)*
+*Defined in [core/http/http-responses.ts:69](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L69)*
#### Type declaration
@@ -111,7 +111,7 @@ ___
**● headers**: *`object`*
-*Defined in [core/http/http-responses.ts:70](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L70)*
+*Defined in [core/http/http-responses.ts:70](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L70)*
#### Type declaration
@@ -124,7 +124,7 @@ ___
**● isHttpResponse**: *`true`* = true
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -137,7 +137,7 @@ ___
**● statusCode**: *`number`*
-*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L51)*
+*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L51)*
Status code of the response.
@@ -154,7 +154,7 @@ ___
**● statusMessage**: *`string`*
-*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L60)*
+*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L60)*
Status message of the response. It must follow the HTTP conventions and be consistent with the statusCode property.
@@ -171,7 +171,7 @@ ___
**● stream**: *`boolean`* = false
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -189,7 +189,7 @@ ___
▸ **getCookie**(name: *`string`*): `object`
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -211,7 +211,7 @@ ___
▸ **getCookies**(): `object`
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -227,7 +227,7 @@ ___
▸ **getHeader**(name: *`string`*): `string` \| `undefined`
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -249,7 +249,7 @@ ___
▸ **getHeaders**(): `object`
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -265,7 +265,7 @@ ___
▸ **setCookie**(name: *`string`*, value: *`string`*, options?: *[CookieOptions](../interfaces/_core_http_http_responses_.cookieoptions.md)*): `this`
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
▸ **setHeader**(name: *`string`*, value: *`string`*): `this`
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsebadrequest.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsebadrequest.md
index 6a53753aca..a7a74ab2e8 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsebadrequest.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsebadrequest.md
@@ -55,7 +55,7 @@ Represent an HTTP response with the status 400 - BAD REQUEST.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L609)*
+*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L609)*
Create an instance of HttpResponseBadRequest.
@@ -85,7 +85,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -96,7 +96,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -109,7 +109,7 @@ ___
**● isHttpResponseBadRequest**: *`true`* = true
-*Defined in [core/http/http-responses.ts:607](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L607)*
+*Defined in [core/http/http-responses.ts:607](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L607)*
Property used internally by isHttpResponseBadRequest.
@@ -124,7 +124,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -139,7 +139,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:608](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L608)*
+*Defined in [core/http/http-responses.ts:608](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L608)*
___
@@ -150,7 +150,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L609)*
+*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L609)*
___
@@ -161,7 +161,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -181,7 +181,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -205,7 +205,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -223,7 +223,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -247,7 +247,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -265,7 +265,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -290,7 +290,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseclienterror.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseclienterror.md
index 72938d9ad8..e9972a2c68 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseclienterror.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseclienterror.md
@@ -66,7 +66,7 @@ Represent an HTTP response with a client error status 4xx.
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[constructor](_core_http_http_responses_.httpresponse.md#constructor)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Create an instance of HttpResponseClientError.
@@ -96,7 +96,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -107,7 +107,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -120,7 +120,7 @@ ___
**● isHttpResponseClientError**: *`true`* = true
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -135,7 +135,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L51)*
+*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L51)*
Status code of the response.
@@ -154,7 +154,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L60)*
+*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L60)*
Status message of the response. It must follow the HTTP conventions and be consistent with the statusCode property.
@@ -173,7 +173,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -193,7 +193,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -217,7 +217,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -235,7 +235,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -259,7 +259,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -277,7 +277,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -302,7 +302,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseconflict.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseconflict.md
index 706f00b6f1..d8c1ad5fbf 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseconflict.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseconflict.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 409 - CONFLICT.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:838](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L838)*
+*Defined in [core/http/http-responses.ts:838](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L838)*
Create an instance of HttpResponseConflict.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -109,7 +109,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -122,7 +122,7 @@ ___
**● isHttpResponseConflict**: *`true`* = true
-*Defined in [core/http/http-responses.ts:836](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L836)*
+*Defined in [core/http/http-responses.ts:836](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L836)*
Property used internally by isHttpResponseConflict.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:837](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L837)*
+*Defined in [core/http/http-responses.ts:837](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L837)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:838](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L838)*
+*Defined in [core/http/http-responses.ts:838](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L838)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsecreated.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsecreated.md
index a697124e41..b3e92ef0b8 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsecreated.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsecreated.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 201 - CREATED.
*Overrides [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[constructor](_core_http_http_responses_.httpresponsesuccess.md#constructor)*
-*Defined in [core/http/http-responses.ts:334](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L334)*
+*Defined in [core/http/http-responses.ts:334](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L334)*
Create an instance of HttpResponseCreated.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -107,7 +107,7 @@ ___
**● isHttpResponseCreated**: *`true`* = true
-*Defined in [core/http/http-responses.ts:332](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L332)*
+*Defined in [core/http/http-responses.ts:332](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L332)*
Property used internally by isHttpResponseCreated.
@@ -122,7 +122,7 @@ ___
*Inherited from [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[isHttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md#ishttpresponsesuccess)*
-*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L198)*
+*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L198)*
Property used internally by isHttpResponseSuccess.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:333](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L333)*
+*Defined in [core/http/http-responses.ts:333](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L333)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:334](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L334)*
+*Defined in [core/http/http-responses.ts:334](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L334)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseforbidden.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseforbidden.md
index 101098c38f..4532b875a8 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseforbidden.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseforbidden.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 403 - FORBIDDEN.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:702](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L702)*
+*Defined in [core/http/http-responses.ts:702](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L702)*
Create an instance of HttpResponseForbidden.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -109,7 +109,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -122,7 +122,7 @@ ___
**● isHttpResponseForbidden**: *`true`* = true
-*Defined in [core/http/http-responses.ts:700](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L700)*
+*Defined in [core/http/http-responses.ts:700](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L700)*
Property used internally by isHttpResponseForbidden.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:701](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L701)*
+*Defined in [core/http/http-responses.ts:701](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L701)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:702](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L702)*
+*Defined in [core/http/http-responses.ts:702](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L702)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseinternalservererror.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseinternalservererror.md
index 0af3b647b3..ab6c2f65cd 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseinternalservererror.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseinternalservererror.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 500 - INTERNAL SERVER ERROR.
*Overrides [HttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md).[constructor](_core_http_http_responses_.httpresponseservererror.md#constructor)*
-*Defined in [core/http/http-responses.ts:924](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L924)*
+*Defined in [core/http/http-responses.ts:924](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L924)*
Create an instance of HttpResponseInternalServerError.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -107,7 +107,7 @@ ___
**● isHttpResponseInternalServerError**: *`true`* = true
-*Defined in [core/http/http-responses.ts:922](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L922)*
+*Defined in [core/http/http-responses.ts:922](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L922)*
Property used internally by isHttpResponseInternalServerError.
@@ -122,7 +122,7 @@ ___
*Inherited from [HttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md).[isHttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md#ishttpresponseservererror)*
-*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L884)*
+*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L884)*
Property used internally by isHttpResponseServerError.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:923](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L923)*
+*Defined in [core/http/http-responses.ts:923](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L923)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:924](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L924)*
+*Defined in [core/http/http-responses.ts:924](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L924)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsemethodnotallowed.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsemethodnotallowed.md
index 4ad53fc1b6..eb429bcfd4 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsemethodnotallowed.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsemethodnotallowed.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 405 - METHOD NOT ALLOWED.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:792](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L792)*
+*Defined in [core/http/http-responses.ts:792](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L792)*
Create an instance of HttpResponseMethodNotAllowed.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -109,7 +109,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -122,7 +122,7 @@ ___
**● isHttpResponseMethodNotAllowed**: *`true`* = true
-*Defined in [core/http/http-responses.ts:790](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L790)*
+*Defined in [core/http/http-responses.ts:790](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L790)*
Property used internally by isHttpResponseMethodNotAllowed.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:791](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L791)*
+*Defined in [core/http/http-responses.ts:791](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L791)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:792](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L792)*
+*Defined in [core/http/http-responses.ts:792](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L792)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsemovedpermanently.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsemovedpermanently.md
index 821c881321..abaa33dbc9 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsemovedpermanently.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsemovedpermanently.md
@@ -54,7 +54,7 @@ Represent an HTTP response with the status 301 - MOVED PERMANENTLY.
*Overrides [HttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md).[constructor](_core_http_http_responses_.httpresponseredirection.md#constructor)*
-*Defined in [core/http/http-responses.ts:470](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L470)*
+*Defined in [core/http/http-responses.ts:470](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L470)*
Create an instance of HttpResponseMovedPermanently.
@@ -80,7 +80,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -91,7 +91,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -104,7 +104,7 @@ ___
**● isHttpResponseMovedPermanently**: *`true`* = true
-*Defined in [core/http/http-responses.ts:468](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L468)*
+*Defined in [core/http/http-responses.ts:468](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L468)*
Property used internally by isHttpResponseMovedPermanently.
@@ -119,7 +119,7 @@ ___
*Inherited from [HttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md).[isHttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md#ishttpresponseredirection)*
-*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L424)*
+*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L424)*
Property used internally by isHttpResponseRediction.
@@ -132,7 +132,7 @@ ___
**● path**: *`string`*
-*Defined in [core/http/http-responses.ts:477](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L477)*
+*Defined in [core/http/http-responses.ts:477](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L477)*
The redirection path.
@@ -145,7 +145,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:469](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L469)*
+*Defined in [core/http/http-responses.ts:469](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L469)*
___
@@ -156,7 +156,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:470](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L470)*
+*Defined in [core/http/http-responses.ts:470](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L470)*
___
@@ -167,7 +167,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -187,7 +187,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -211,7 +211,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -229,7 +229,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -253,7 +253,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -271,7 +271,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -296,7 +296,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsenocontent.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsenocontent.md
index f2efb03967..6d77a8a80b 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsenocontent.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsenocontent.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 204 - NO CONTENT.
*Overrides [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[constructor](_core_http_http_responses_.httpresponsesuccess.md#constructor)*
-*Defined in [core/http/http-responses.ts:379](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L379)*
+*Defined in [core/http/http-responses.ts:379](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L379)*
Create an instance of HttpResponseNoContent.
@@ -73,7 +73,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -84,7 +84,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -97,7 +97,7 @@ ___
**● isHttpResponseNoContent**: *`true`* = true
-*Defined in [core/http/http-responses.ts:377](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L377)*
+*Defined in [core/http/http-responses.ts:377](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L377)*
Property used internally by is HttpResponseNoContent.
@@ -112,7 +112,7 @@ ___
*Inherited from [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[isHttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md#ishttpresponsesuccess)*
-*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L198)*
+*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L198)*
Property used internally by isHttpResponseSuccess.
@@ -127,7 +127,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:378](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L378)*
+*Defined in [core/http/http-responses.ts:378](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L378)*
___
@@ -138,7 +138,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:379](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L379)*
+*Defined in [core/http/http-responses.ts:379](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L379)*
___
@@ -149,7 +149,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -169,7 +169,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -193,7 +193,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -211,7 +211,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -235,7 +235,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -253,7 +253,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -278,7 +278,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsenotfound.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsenotfound.md
index 3ee9620ac4..2049ec8a6b 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsenotfound.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsenotfound.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 404 - NOT FOUND.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:747](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L747)*
+*Defined in [core/http/http-responses.ts:747](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L747)*
Create an instance of HttpResponseNotFound.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -109,7 +109,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -122,7 +122,7 @@ ___
**● isHttpResponseNotFound**: *`true`* = true
-*Defined in [core/http/http-responses.ts:745](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L745)*
+*Defined in [core/http/http-responses.ts:745](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L745)*
Property used internally by isHttpResponseNotFound.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:746](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L746)*
+*Defined in [core/http/http-responses.ts:746](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L746)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:747](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L747)*
+*Defined in [core/http/http-responses.ts:747](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L747)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsenotimplemented.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsenotimplemented.md
index 2c62135b55..431c00eaba 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsenotimplemented.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsenotimplemented.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 501 - NOT IMPLEMENTED.
*Overrides [HttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md).[constructor](_core_http_http_responses_.httpresponseservererror.md#constructor)*
-*Defined in [core/http/http-responses.ts:970](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L970)*
+*Defined in [core/http/http-responses.ts:970](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L970)*
Create an instance of HttpResponseNotImplemented.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -107,7 +107,7 @@ ___
**● isHttpResponseNotImplemented**: *`true`* = true
-*Defined in [core/http/http-responses.ts:968](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L968)*
+*Defined in [core/http/http-responses.ts:968](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L968)*
Property used internally by isHttpResponseNotImplemented.
@@ -122,7 +122,7 @@ ___
*Inherited from [HttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md).[isHttpResponseServerError](_core_http_http_responses_.httpresponseservererror.md#ishttpresponseservererror)*
-*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L884)*
+*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L884)*
Property used internally by isHttpResponseServerError.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:969](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L969)*
+*Defined in [core/http/http-responses.ts:969](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L969)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:970](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L970)*
+*Defined in [core/http/http-responses.ts:970](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L970)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseok.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseok.md
index 59a31a0f33..1c0b16f9d9 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseok.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseok.md
@@ -53,7 +53,7 @@ Represent an HTTP response with the status 200 - OK.
*Overrides [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[constructor](_core_http_http_responses_.httpresponsesuccess.md#constructor)*
-*Defined in [core/http/http-responses.ts:243](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L243)*
+*Defined in [core/http/http-responses.ts:243](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L243)*
Create an instance of HttpResponseOK.
@@ -83,7 +83,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -94,7 +94,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -107,7 +107,7 @@ ___
**● isHttpResponseOK**: *`true`* = true
-*Defined in [core/http/http-responses.ts:241](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L241)*
+*Defined in [core/http/http-responses.ts:241](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L241)*
Property used internally by isHttpResponOK.
@@ -122,7 +122,7 @@ ___
*Inherited from [HttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md).[isHttpResponseSuccess](_core_http_http_responses_.httpresponsesuccess.md#ishttpresponsesuccess)*
-*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L198)*
+*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L198)*
Property used internally by isHttpResponseSuccess.
@@ -137,7 +137,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:242](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L242)*
+*Defined in [core/http/http-responses.ts:242](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L242)*
___
@@ -148,7 +148,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:243](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L243)*
+*Defined in [core/http/http-responses.ts:243](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L243)*
___
@@ -159,7 +159,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -179,7 +179,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -203,7 +203,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -221,7 +221,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -245,7 +245,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -263,7 +263,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -288,7 +288,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseredirect.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseredirect.md
index d40f08b5d0..c4eb0d624d 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseredirect.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseredirect.md
@@ -54,7 +54,7 @@ Represent an HTTP response with the status 302 - FOUND.
*Overrides [HttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md).[constructor](_core_http_http_responses_.httpresponseredirection.md#constructor)*
-*Defined in [core/http/http-responses.ts:516](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L516)*
+*Defined in [core/http/http-responses.ts:516](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L516)*
Create an instance of HttpResponseRedirect.
@@ -88,7 +88,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -99,7 +99,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -112,7 +112,7 @@ ___
**● isHttpResponseRedirect**: *`true`* = true
-*Defined in [core/http/http-responses.ts:514](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L514)*
+*Defined in [core/http/http-responses.ts:514](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L514)*
Property used internally by isHttpResponseRedirect.
@@ -127,7 +127,7 @@ ___
*Inherited from [HttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md).[isHttpResponseRedirection](_core_http_http_responses_.httpresponseredirection.md#ishttpresponseredirection)*
-*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L424)*
+*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L424)*
Property used internally by isHttpResponseRediction.
@@ -140,7 +140,7 @@ ___
**● path**: *`string`*
-*Defined in [core/http/http-responses.ts:524](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L524)*
+*Defined in [core/http/http-responses.ts:524](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L524)*
The redirection path.
@@ -153,7 +153,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:515](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L515)*
+*Defined in [core/http/http-responses.ts:515](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L515)*
___
@@ -164,7 +164,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:516](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L516)*
+*Defined in [core/http/http-responses.ts:516](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L516)*
___
@@ -175,7 +175,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -195,7 +195,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -219,7 +219,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -237,7 +237,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -261,7 +261,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -279,7 +279,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -304,7 +304,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseredirection.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseredirection.md
index 476cbdb4d7..1582c937a0 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseredirection.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseredirection.md
@@ -58,7 +58,7 @@ Represent an HTTP response with a redirection status 3xx.
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[constructor](_core_http_http_responses_.httpresponse.md#constructor)*
-*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L424)*
+*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L424)*
Create an instance of HttpResponseRedirection.
@@ -88,7 +88,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -99,7 +99,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -112,7 +112,7 @@ ___
**● isHttpResponseRedirection**: *`true`* = true
-*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L424)*
+*Defined in [core/http/http-responses.ts:424](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L424)*
Property used internally by isHttpResponseRediction.
@@ -127,7 +127,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L51)*
+*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L51)*
Status code of the response.
@@ -146,7 +146,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L60)*
+*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L60)*
Status message of the response. It must follow the HTTP conventions and be consistent with the statusCode property.
@@ -165,7 +165,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -185,7 +185,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -209,7 +209,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -227,7 +227,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -251,7 +251,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -269,7 +269,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -294,7 +294,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseservererror.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseservererror.md
index f04dfa175d..00b3b83aee 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseservererror.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseservererror.md
@@ -58,7 +58,7 @@ Represent an HTTP response with a server error status 5xx.
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[constructor](_core_http_http_responses_.httpresponse.md#constructor)*
-*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L884)*
+*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L884)*
**Parameters:**
@@ -84,7 +84,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -95,7 +95,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -108,7 +108,7 @@ ___
**● isHttpResponseServerError**: *`true`* = true
-*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L884)*
+*Defined in [core/http/http-responses.ts:884](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L884)*
Property used internally by isHttpResponseServerError.
@@ -123,7 +123,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L51)*
+*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L51)*
Status code of the response.
@@ -142,7 +142,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L60)*
+*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L60)*
Status message of the response. It must follow the HTTP conventions and be consistent with the statusCode property.
@@ -161,7 +161,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -181,7 +181,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -205,7 +205,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -223,7 +223,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -247,7 +247,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -265,7 +265,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -290,7 +290,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponsesuccess.md b/docs/api/core/classes/_core_http_http_responses_.httpresponsesuccess.md
index fbfc2acd45..3299ddad04 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponsesuccess.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponsesuccess.md
@@ -60,7 +60,7 @@ Represent an HTTP response with a success status 2xx.
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[constructor](_core_http_http_responses_.httpresponse.md#constructor)*
-*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L198)*
+*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L198)*
Create an instance of HttpResponseSuccess.
@@ -90,7 +90,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -101,7 +101,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -114,7 +114,7 @@ ___
**● isHttpResponseSuccess**: *`true`* = true
-*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L198)*
+*Defined in [core/http/http-responses.ts:198](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L198)*
Property used internally by isHttpResponseSuccess.
@@ -129,7 +129,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L51)*
+*Defined in [core/http/http-responses.ts:51](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L51)*
Status code of the response.
@@ -148,7 +148,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L60)*
+*Defined in [core/http/http-responses.ts:60](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L60)*
Status message of the response. It must follow the HTTP conventions and be consistent with the statusCode property.
@@ -167,7 +167,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -187,7 +187,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -211,7 +211,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -229,7 +229,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -253,7 +253,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -271,7 +271,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -296,7 +296,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_http_http_responses_.httpresponseunauthorized.md b/docs/api/core/classes/_core_http_http_responses_.httpresponseunauthorized.md
index f7a6d82e67..f5d81ac441 100644
--- a/docs/api/core/classes/_core_http_http_responses_.httpresponseunauthorized.md
+++ b/docs/api/core/classes/_core_http_http_responses_.httpresponseunauthorized.md
@@ -55,7 +55,7 @@ Represent an HTTP response with the status 401 - UNAUTHORIZED.
*Overrides [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[constructor](_core_http_http_responses_.httpresponseclienterror.md#constructor)*
-*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L655)*
+*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L655)*
Create an instance of HttpResponseUnauthorized.
@@ -85,7 +85,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -96,7 +96,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -111,7 +111,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -124,7 +124,7 @@ ___
**● isHttpResponseUnauthorized**: *`true`* = true
-*Defined in [core/http/http-responses.ts:653](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L653)*
+*Defined in [core/http/http-responses.ts:653](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L653)*
Property used internally by isHttpResponseUnauthorized.
@@ -139,7 +139,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:654](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L654)*
+*Defined in [core/http/http-responses.ts:654](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L654)*
___
@@ -150,7 +150,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L655)*
+*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L655)*
___
@@ -161,7 +161,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -181,7 +181,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -205,7 +205,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -223,7 +223,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -247,7 +247,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -265,7 +265,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -290,7 +290,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_core_service_manager_.servicemanager.md b/docs/api/core/classes/_core_service_manager_.servicemanager.md
index a4ce19804a..b9baf32a13 100644
--- a/docs/api/core/classes/_core_service_manager_.servicemanager.md
+++ b/docs/api/core/classes/_core_service_manager_.servicemanager.md
@@ -33,7 +33,7 @@ Identity Mapper that instantiates and returns service singletons.
**● map**: *`Map`<[Class](../modules/_core_class_interface_.md#class)<`any`>, `any`>* = new Map()
-*Defined in [core/service-manager.ts:70](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L70)*
+*Defined in [core/service-manager.ts:70](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L70)*
___
@@ -45,7 +45,7 @@ ___
▸ **get**<`Service`>(serviceClass: *[Class](../modules/_core_class_interface_.md#class)<`Service`>*): `Service`
-*Defined in [core/service-manager.ts:93](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L93)*
+*Defined in [core/service-manager.ts:93](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L93)*
Get (and create if necessary) the service singleton.
@@ -72,7 +72,7 @@ ___
▸ **set**<`Service`>(serviceClass: *[Class](../modules/_core_class_interface_.md#class)<`Service`>*, service: *`any`*): `void`
-*Defined in [core/service-manager.ts:81](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L81)*
+*Defined in [core/service-manager.ts:81](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L81)*
Add manually a service to the identity mapper. This function is useful during tests to inject mocks.
diff --git a/docs/api/core/classes/_openapi_openapi_service_.openapi.md b/docs/api/core/classes/_openapi_openapi_service_.openapi.md
index 1ed484e850..27029ac2d3 100644
--- a/docs/api/core/classes/_openapi_openapi_service_.openapi.md
+++ b/docs/api/core/classes/_openapi_openapi_service_.openapi.md
@@ -32,7 +32,7 @@ Service to create OpenAPI documents.
**● controllers**: *[ServiceManager](_core_service_manager_.servicemanager.md)*
-*Defined in [openapi/openapi.service.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/openapi.service.ts#L13)*
+*Defined in [openapi/openapi.service.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/openapi.service.ts#L13)*
___
@@ -44,7 +44,7 @@ ___
▸ **createDocument**(controllerClass: *[Class](../modules/_core_class_interface_.md#class)*): [IOpenAPI](../interfaces/_openapi_interfaces_.iopenapi.md)
-*Defined in [openapi/openapi.service.ts:22](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/openapi.service.ts#L22)*
+*Defined in [openapi/openapi.service.ts:22](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/openapi.service.ts#L22)*
Create an OpenAPI document from a controller class.
diff --git a/docs/api/core/classes/_sessions_session_.session.md b/docs/api/core/classes/_sessions_session_.session.md
index 01f4d193fb..4d7fb29bed 100644
--- a/docs/api/core/classes/_sessions_session_.session.md
+++ b/docs/api/core/classes/_sessions_session_.session.md
@@ -47,7 +47,7 @@ Representation of a server/database session.
⊕ **new Session**(sessionID: *`string`*, sessionContent: *`object`*, createdAt: *`number`*): [Session](_sessions_session_.session.md)
-*Defined in [sessions/session.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L30)*
+*Defined in [sessions/session.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L30)*
**Parameters:**
@@ -69,7 +69,7 @@ ___
**● createdAt**: *`number`*
-*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L32)*
+*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L32)*
___
@@ -78,7 +78,7 @@ ___
**● modified**: *`boolean`* = false
-*Defined in [sessions/session.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L30)*
+*Defined in [sessions/session.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L30)*
___
@@ -87,7 +87,7 @@ ___
**● sessionContent**: *`object`*
-*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L32)*
+*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L32)*
___
@@ -96,7 +96,7 @@ ___
**● sessionID**: *`string`*
-*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L32)*
+*Defined in [sessions/session.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L32)*
___
@@ -108,7 +108,7 @@ ___
**get isModified**(): `boolean`
-*Defined in [sessions/session.ts:45](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L45)*
+*Defined in [sessions/session.ts:45](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L45)*
Return true if an element was added/replaces in the session
@@ -132,7 +132,7 @@ ___
▸ **get**<`T`>(key: *`string`*, defaultValue: *`any`*): `T`
-*Defined in [sessions/session.ts:70](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L70)*
+*Defined in [sessions/session.ts:70](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L70)*
The value of an element in the session content.
@@ -152,7 +152,7 @@ The value of an element in the session content.
**Returns:** `T` \| `undefined`
The property valye
-*Defined in [sessions/session.ts:71](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L71)*
+*Defined in [sessions/session.ts:71](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L71)*
**Type parameters:**
@@ -173,7 +173,7 @@ ___
▸ **getContent**(): `object`
-*Defined in [sessions/session.ts:100](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L100)*
+*Defined in [sessions/session.ts:100](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L100)*
Get a copy of the session content.
@@ -189,7 +189,7 @@ ___
▸ **getToken**(): `string`
-*Defined in [sessions/session.ts:86](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L86)*
+*Defined in [sessions/session.ts:86](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L86)*
Get the session token. This token is used by `@TokenRequired` and `@TokenOptional` to retreive the session and the authenticated user if she/he exists.
@@ -205,7 +205,7 @@ ___
▸ **set**(key: *`string`*, value: *`any`*): `void`
-*Defined in [sessions/session.ts:57](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L57)*
+*Defined in [sessions/session.ts:57](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L57)*
Add/replace an element in the session. This operation is not saved in the saved unless you call SessionStore.update(session).
@@ -227,7 +227,7 @@ ___
▸ **verifyTokenAndGetId**(token: *`string`*): `string` \| `false`
-*Defined in [sessions/session.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session.ts#L21)*
+*Defined in [sessions/session.ts:21](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session.ts#L21)*
Verify a session token and return the sessionID if the token is valid.
diff --git a/docs/api/core/classes/_sessions_session_store_.sessionstore.md b/docs/api/core/classes/_sessions_session_store_.sessionstore.md
index 11d9551ffb..f625f67ac3 100644
--- a/docs/api/core/classes/_sessions_session_store_.sessionstore.md
+++ b/docs/api/core/classes/_sessions_session_store_.sessionstore.md
@@ -44,7 +44,7 @@ Examples of SessionStore: TypeORMStore, RedisStore, MongoDBStore.
▸ **applySessionOptions**(content: *`object`*, options: *[SessionOptions](../interfaces/_sessions_session_store_.sessionoptions.md)*): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:174](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L174)*
+*Defined in [sessions/session-store.ts:174](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L174)*
Apply session options to the given session content.
@@ -66,7 +66,7 @@ ___
▸ **cleanUpExpiredSessions**(): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:151](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L151)*
+*Defined in [sessions/session-store.ts:151](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L151)*
Some session stores may need to run periodically background jobs to cleanup expired sessions.
@@ -85,7 +85,7 @@ ___
▸ **clear**(): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:141](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L141)*
+*Defined in [sessions/session-store.ts:141](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L141)*
Clear all sessions.
@@ -102,7 +102,7 @@ ___
▸ **createAndSaveSession**(sessionContent: *`object`*, options?: *[SessionOptions](../interfaces/_sessions_session_store_.sessionoptions.md)*): `Promise`<[Session](_sessions_session_.session.md)>
-*Defined in [sessions/session-store.ts:90](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L90)*
+*Defined in [sessions/session-store.ts:90](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L90)*
Create and save a new session.
@@ -129,7 +129,7 @@ ___
▸ **createAndSaveSessionFromUser**(user: *`object`*, options?: *[SessionOptions](../interfaces/_sessions_session_store_.sessionoptions.md)*): `Promise`<[Session](_sessions_session_.session.md)>
-*Defined in [sessions/session-store.ts:73](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L73)*
+*Defined in [sessions/session-store.ts:73](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L73)*
Create and save an new session from a user.
@@ -157,7 +157,7 @@ ___
▸ **destroy**(sessionID: *`string`*): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:110](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L110)*
+*Defined in [sessions/session-store.ts:110](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L110)*
Delete a session, whether it exists or not.
@@ -180,7 +180,7 @@ ___
▸ **extendLifeTime**(sessionID: *`string`*): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:133](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L133)*
+*Defined in [sessions/session-store.ts:133](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L133)*
Extend the lifetime of a session from its ID. The duration is the inactivity timeout.
@@ -205,7 +205,7 @@ ___
▸ **generateSessionID**(): `Promise`<`string`>
-*Defined in [sessions/session-store.ts:160](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L160)*
+*Defined in [sessions/session-store.ts:160](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L160)*
Generate a 128-bit base64url-encoded session ID.
@@ -221,7 +221,7 @@ ___
▸ **read**(sessionID: *`string`*): `Promise`<[Session](_sessions_session_.session.md) \| `undefined`>
-*Defined in [sessions/session-store.ts:121](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L121)*
+*Defined in [sessions/session-store.ts:121](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L121)*
Read a session from its ID.
@@ -247,7 +247,7 @@ ___
▸ **update**(session: *[Session](_sessions_session_.session.md)*): `Promise`<`void`>
-*Defined in [sessions/session-store.ts:101](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L101)*
+*Defined in [sessions/session-store.ts:101](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L101)*
Update and extend the lifetime of a session.
@@ -272,7 +272,7 @@ ___
▸ **getExpirationTimeouts**(): `object`
-*Defined in [sessions/session-store.ts:43](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L43)*
+*Defined in [sessions/session-store.ts:43](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L43)*
Read session expiration timeouts from the configuration.
diff --git a/docs/api/core/classes/_sessions_token_hook_.invalidrequestresponse.md b/docs/api/core/classes/_sessions_token_hook_.invalidrequestresponse.md
index eb12c2938e..5967fcf219 100644
--- a/docs/api/core/classes/_sessions_token_hook_.invalidrequestresponse.md
+++ b/docs/api/core/classes/_sessions_token_hook_.invalidrequestresponse.md
@@ -45,7 +45,7 @@
*Overrides [HttpResponseBadRequest](_core_http_http_responses_.httpresponsebadrequest.md).[constructor](_core_http_http_responses_.httpresponsebadrequest.md#constructor)*
-*Defined in [sessions/token.hook.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L14)*
+*Defined in [sessions/token.hook.ts:16](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L16)*
**Parameters:**
@@ -67,7 +67,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -78,7 +78,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -93,7 +93,7 @@ ___
*Inherited from [HttpResponseBadRequest](_core_http_http_responses_.httpresponsebadrequest.md).[isHttpResponseBadRequest](_core_http_http_responses_.httpresponsebadrequest.md#ishttpresponsebadrequest)*
-*Defined in [core/http/http-responses.ts:607](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L607)*
+*Defined in [core/http/http-responses.ts:607](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L607)*
Property used internally by isHttpResponseBadRequest.
@@ -108,7 +108,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -125,7 +125,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:608](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L608)*
+*Defined in [core/http/http-responses.ts:608](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L608)*
___
@@ -138,7 +138,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L609)*
+*Defined in [core/http/http-responses.ts:609](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L609)*
___
@@ -149,7 +149,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -169,7 +169,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -193,7 +193,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -211,7 +211,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -235,7 +235,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -253,7 +253,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -278,7 +278,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/classes/_sessions_token_hook_.invalidtokenresponse.md b/docs/api/core/classes/_sessions_token_hook_.invalidtokenresponse.md
index 87317d1d39..be529e5337 100644
--- a/docs/api/core/classes/_sessions_token_hook_.invalidtokenresponse.md
+++ b/docs/api/core/classes/_sessions_token_hook_.invalidtokenresponse.md
@@ -45,7 +45,7 @@
*Overrides [HttpResponseUnauthorized](_core_http_http_responses_.httpresponseunauthorized.md).[constructor](_core_http_http_responses_.httpresponseunauthorized.md#constructor)*
-*Defined in [sessions/token.hook.ts:22](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L22)*
+*Defined in [sessions/token.hook.ts:24](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L24)*
**Parameters:**
@@ -67,7 +67,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[body](_core_http_http_responses_.httpresponse.md#body)*
-*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L77)*
+*Defined in [core/http/http-responses.ts:77](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L77)*
___
@@ -78,7 +78,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[isHttpResponse](_core_http_http_responses_.httpresponse.md#ishttpresponse)*
-*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L42)*
+*Defined in [core/http/http-responses.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L42)*
Property used internally by isHttpResponse.
@@ -93,7 +93,7 @@ ___
*Inherited from [HttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md).[isHttpResponseClientError](_core_http_http_responses_.httpresponseclienterror.md#ishttpresponseclienterror)*
-*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L563)*
+*Defined in [core/http/http-responses.ts:563](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L563)*
Property used internally by isHttpResponseClientError.
@@ -108,7 +108,7 @@ ___
*Inherited from [HttpResponseUnauthorized](_core_http_http_responses_.httpresponseunauthorized.md).[isHttpResponseUnauthorized](_core_http_http_responses_.httpresponseunauthorized.md#ishttpresponseunauthorized)*
-*Defined in [core/http/http-responses.ts:653](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L653)*
+*Defined in [core/http/http-responses.ts:653](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L653)*
Property used internally by isHttpResponseUnauthorized.
@@ -125,7 +125,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusCode](_core_http_http_responses_.httpresponse.md#statuscode)*
-*Defined in [core/http/http-responses.ts:654](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L654)*
+*Defined in [core/http/http-responses.ts:654](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L654)*
___
@@ -138,7 +138,7 @@ ___
*Overrides [HttpResponse](_core_http_http_responses_.httpresponse.md).[statusMessage](_core_http_http_responses_.httpresponse.md#statusmessage)*
-*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L655)*
+*Defined in [core/http/http-responses.ts:655](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L655)*
___
@@ -149,7 +149,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[stream](_core_http_http_responses_.httpresponse.md#stream)*
-*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L67)*
+*Defined in [core/http/http-responses.ts:67](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L67)*
Specify if the body property is a stream.
@@ -169,7 +169,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookie](_core_http_http_responses_.httpresponse.md#getcookie)*
-*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L138)*
+*Defined in [core/http/http-responses.ts:138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L138)*
Read the value and directives of a cookie added with setCookie.
@@ -193,7 +193,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getCookies](_core_http_http_responses_.httpresponse.md#getcookies)*
-*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L153)*
+*Defined in [core/http/http-responses.ts:153](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L153)*
Read all the cookies added with setCookie.
@@ -211,7 +211,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeader](_core_http_http_responses_.httpresponse.md#getheader)*
-*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L102)*
+*Defined in [core/http/http-responses.ts:102](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L102)*
Read the value of a header added with setHeader.
@@ -235,7 +235,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[getHeaders](_core_http_http_responses_.httpresponse.md#getheaders)*
-*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L112)*
+*Defined in [core/http/http-responses.ts:112](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L112)*
Read all the headers added with setHeader.
@@ -253,7 +253,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setCookie](_core_http_http_responses_.httpresponse.md#setcookie)*
-*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L125)*
+*Defined in [core/http/http-responses.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L125)*
Add or replace a cookie in the response.
@@ -278,7 +278,7 @@ ___
*Inherited from [HttpResponse](_core_http_http_responses_.httpresponse.md).[setHeader](_core_http_http_responses_.httpresponse.md#setheader)*
-*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L89)*
+*Defined in [core/http/http-responses.ts:89](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L89)*
Add or replace a header in the response.
diff --git a/docs/api/core/interfaces/_common_hooks_log_hook_.logoptions.md b/docs/api/core/interfaces/_common_hooks_log_hook_.logoptions.md
index 66ab5841ef..3ec6ed8b84 100644
--- a/docs/api/core/interfaces/_common_hooks_log_hook_.logoptions.md
+++ b/docs/api/core/interfaces/_common_hooks_log_hook_.logoptions.md
@@ -32,7 +32,7 @@ Options of the `Log` hook.
**● body**: *`undefined` \| `false` \| `true`*
-*Defined in [common/hooks/log.hook.ts:10](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L10)*
+*Defined in [common/hooks/log.hook.ts:10](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L10)*
___
@@ -41,7 +41,7 @@ ___
**● headers**: *`string`[] \| `boolean`*
-*Defined in [common/hooks/log.hook.ts:12](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L12)*
+*Defined in [common/hooks/log.hook.ts:12](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L12)*
___
@@ -50,7 +50,7 @@ ___
**● logFn**: *`undefined` \| `function`*
-*Defined in [common/hooks/log.hook.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L14)*
+*Defined in [common/hooks/log.hook.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L14)*
___
@@ -59,7 +59,7 @@ ___
**● params**: *`undefined` \| `false` \| `true`*
-*Defined in [common/hooks/log.hook.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L11)*
+*Defined in [common/hooks/log.hook.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L11)*
___
@@ -68,7 +68,7 @@ ___
**● query**: *`undefined` \| `false` \| `true`*
-*Defined in [common/hooks/log.hook.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L13)*
+*Defined in [common/hooks/log.hook.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L13)*
___
diff --git a/docs/api/core/interfaces/_core_http_http_responses_.cookieoptions.md b/docs/api/core/interfaces/_core_http_http_responses_.cookieoptions.md
index 202875f112..0ef2b21c58 100644
--- a/docs/api/core/interfaces/_core_http_http_responses_.cookieoptions.md
+++ b/docs/api/core/interfaces/_core_http_http_responses_.cookieoptions.md
@@ -36,7 +36,7 @@ The value of maxAge is in seconds.
**● domain**: *`undefined` \| `string`*
-*Defined in [core/http/http-responses.ts:18](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L18)*
+*Defined in [core/http/http-responses.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L18)*
___
@@ -45,7 +45,7 @@ ___
**● expires**: *`Date`*
-*Defined in [core/http/http-responses.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L19)*
+*Defined in [core/http/http-responses.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L19)*
___
@@ -54,7 +54,7 @@ ___
**● httpOnly**: *`undefined` \| `false` \| `true`*
-*Defined in [core/http/http-responses.ts:20](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L20)*
+*Defined in [core/http/http-responses.ts:20](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L20)*
___
@@ -63,7 +63,7 @@ ___
**● maxAge**: *`undefined` \| `number`*
-*Defined in [core/http/http-responses.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L21)*
+*Defined in [core/http/http-responses.ts:21](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L21)*
___
@@ -72,7 +72,7 @@ ___
**● path**: *`undefined` \| `string`*
-*Defined in [core/http/http-responses.ts:22](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L22)*
+*Defined in [core/http/http-responses.ts:22](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L22)*
___
@@ -81,7 +81,7 @@ ___
**● sameSite**: *"strict" \| "lax"*
-*Defined in [core/http/http-responses.ts:24](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L24)*
+*Defined in [core/http/http-responses.ts:24](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L24)*
___
@@ -90,7 +90,7 @@ ___
**● secure**: *`undefined` \| `false` \| `true`*
-*Defined in [core/http/http-responses.ts:23](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L23)*
+*Defined in [core/http/http-responses.ts:23](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L23)*
___
diff --git a/docs/api/core/interfaces/_core_routes_route_interface_.route.md b/docs/api/core/interfaces/_core_routes_route_interface_.route.md
index 34fe1043a2..3720bb1310 100644
--- a/docs/api/core/interfaces/_core_routes_route_interface_.route.md
+++ b/docs/api/core/interfaces/_core_routes_route_interface_.route.md
@@ -32,7 +32,7 @@ Represent a Foal route with its controller handler and hooks.
**● controller**: *`any`*
-*Defined in [core/routes/route.interface.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/route.interface.ts#L14)*
+*Defined in [core/routes/route.interface.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/route.interface.ts#L14)*
___
@@ -41,7 +41,7 @@ ___
**● hooks**: *[HookFunction](../modules/_core_hooks_.md#hookfunction)[]*
-*Defined in [core/routes/route.interface.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/route.interface.ts#L13)*
+*Defined in [core/routes/route.interface.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/route.interface.ts#L13)*
___
@@ -50,7 +50,7 @@ ___
**● httpMethod**: *[HttpMethod](../modules/_core_http_http_methods_.md#httpmethod)*
-*Defined in [core/routes/route.interface.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/route.interface.ts#L11)*
+*Defined in [core/routes/route.interface.ts:11](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/route.interface.ts#L11)*
___
@@ -59,7 +59,7 @@ ___
**● path**: *`string`*
-*Defined in [core/routes/route.interface.ts:12](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/route.interface.ts#L12)*
+*Defined in [core/routes/route.interface.ts:12](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/route.interface.ts#L12)*
___
@@ -68,7 +68,7 @@ ___
**● propertyKey**: *`string`*
-*Defined in [core/routes/route.interface.ts:15](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/route.interface.ts#L15)*
+*Defined in [core/routes/route.interface.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/route.interface.ts#L15)*
___
diff --git a/docs/api/core/interfaces/_core_service_manager_.dependency.md b/docs/api/core/interfaces/_core_service_manager_.dependency.md
index 6c6cf236a6..222e333a4e 100644
--- a/docs/api/core/interfaces/_core_service_manager_.dependency.md
+++ b/docs/api/core/interfaces/_core_service_manager_.dependency.md
@@ -23,7 +23,7 @@
**● propertyKey**: *`string`*
-*Defined in [core/service-manager.ts:6](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L6)*
+*Defined in [core/service-manager.ts:6](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L6)*
___
@@ -32,7 +32,7 @@ ___
**● serviceClass**: *[Class](../modules/_core_class_interface_.md#class)*
-*Defined in [core/service-manager.ts:7](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L7)*
+*Defined in [core/service-manager.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L7)*
___
diff --git a/docs/api/core/interfaces/_express_create_app_.expressapplication.md b/docs/api/core/interfaces/_express_create_app_.expressapplication.md
index a9960d76a5..ec466cdf09 100644
--- a/docs/api/core/interfaces/_express_create_app_.expressapplication.md
+++ b/docs/api/core/interfaces/_express_create_app_.expressapplication.md
@@ -2,6 +2,10 @@
# Interface: ExpressApplication
+## Type parameters
+#### P : `Params`
+#### ResBody
+#### ReqBody
## Hierarchy
`Express`
@@ -11,9 +15,9 @@
## Callable
▸ **__call**(req: *`Request` \| `IncomingMessage`*, res: *`Response` \| `ServerResponse`*): `any`
-▸ **__call**(req: *`Request`*, res: *`Response`*, next: *`NextFunction`*): `any`
+▸ **__call**(req: *`Request`<`P`, `ResBody`, `ReqBody`>*, res: *`Response`<`ResBody`>*, next: *`NextFunction`*): `any`
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:852*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:874*
Express instance itself is a request handler, which could be invoked without third argument.
@@ -26,14 +30,14 @@ Express instance itself is a request handler, which could be invoked without thi
**Returns:** `any`
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:34*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:41*
**Parameters:**
| Name | Type |
| ------ | ------ |
-| req | `Request` |
-| res | `Response` |
+| req | `Request`<`P`, `ResBody`, `ReqBody`> |
+| res | `Response`<`ResBody`> |
| next | `NextFunction` |
**Returns:** `any`
@@ -130,7 +134,7 @@ Express instance itself is a request handler, which could be invoked without thi
*Inherited from Application._router*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1030*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1052*
Used to get all registered routes in Express Application
@@ -143,7 +147,7 @@ ___
*Inherited from IRouter.all*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:96*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:109*
Special-cased "all" method, applying the given route `path`, middleware, and callback to _every_ HTTP method.
@@ -156,7 +160,7 @@ ___
*Inherited from IRouter.checkout*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:105*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:118*
___
@@ -167,7 +171,7 @@ ___
*Inherited from IRouter.connect*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:106*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:119*
___
@@ -178,7 +182,7 @@ ___
*Inherited from IRouter.copy*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:107*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:120*
___
@@ -189,7 +193,7 @@ ___
*Inherited from IRouter.delete*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:100*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:113*
___
@@ -202,7 +206,7 @@ ___
*Overrides IRouter.get*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:916*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:938*
___
@@ -213,7 +217,7 @@ ___
*Inherited from IRouter.head*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:103*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:116*
___
@@ -224,7 +228,7 @@ ___
*Inherited from Application.locals*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1015*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1037*
___
@@ -235,7 +239,7 @@ ___
*Inherited from IRouter.lock*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:108*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:121*
___
@@ -246,7 +250,7 @@ ___
*Inherited from IRouter."m-search"*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:113*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:126*
___
@@ -257,7 +261,7 @@ ___
*Inherited from Application.map*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1013*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1035*
___
@@ -268,7 +272,7 @@ ___
*Inherited from IRouter.merge*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:109*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:122*
___
@@ -279,7 +283,7 @@ ___
*Inherited from IRouter.mkactivity*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:110*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:123*
___
@@ -290,7 +294,7 @@ ___
*Inherited from IRouter.mkcol*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:111*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:124*
___
@@ -301,7 +305,7 @@ ___
*Inherited from Application.mountpath*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1048*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1070*
The app.mountpath property contains one or more path patterns on which a sub-app was mounted.
@@ -314,7 +318,7 @@ ___
*Inherited from IRouter.move*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:112*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:125*
___
@@ -325,7 +329,7 @@ ___
*Inherited from IRouter.notify*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:114*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:127*
___
@@ -338,7 +342,7 @@ ___
*Overrides EventEmitter.on*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1043*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1065*
The mount event is fired on a sub-app, when it is mounted on a parent app. The parent app is passed to the callback function.
@@ -368,7 +372,7 @@ ___
*Inherited from IRouter.options*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:102*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:115*
___
@@ -379,7 +383,7 @@ ___
*Inherited from IRouter.patch*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:101*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:114*
___
@@ -390,7 +394,7 @@ ___
*Inherited from IRouter.post*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:98*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:111*
___
@@ -401,7 +405,7 @@ ___
*Inherited from IRouter.propfind*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:115*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:128*
___
@@ -412,7 +416,7 @@ ___
*Inherited from IRouter.proppatch*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:116*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:129*
___
@@ -423,7 +427,7 @@ ___
*Inherited from IRouter.purge*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:117*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:130*
___
@@ -434,7 +438,7 @@ ___
*Inherited from IRouter.put*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:99*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:112*
___
@@ -445,7 +449,7 @@ ___
*Inherited from IRouter.report*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:118*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:131*
___
@@ -456,7 +460,7 @@ ___
*Inherited from Express.request*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1052*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1074*
___
@@ -467,7 +471,7 @@ ___
*Inherited from Application.resource*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1011*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1033*
___
@@ -478,7 +482,7 @@ ___
*Inherited from Express.response*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1053*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1075*
___
@@ -489,7 +493,7 @@ ___
*Inherited from Application.router*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1007*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1029*
___
@@ -500,7 +504,7 @@ ___
*Inherited from Application.routes*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1025*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1047*
The app.routes object houses all of the routes defined mapped by the associated HTTP verb. This object may be used for introspection capabilities, for example Express uses this internally not only for routing but to provide default OPTIONS behaviour unless app.options() is used. Your application or framework may also remove routes by simply by removing them from this object.
@@ -513,7 +517,7 @@ ___
*Inherited from IRouter.search*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:119*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:132*
___
@@ -524,7 +528,7 @@ ___
*Inherited from Application.settings*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1009*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1031*
___
@@ -535,7 +539,7 @@ ___
*Inherited from IRouter.stack*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:131*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:144*
Stack of configured routes
@@ -548,7 +552,7 @@ ___
*Inherited from IRouter.subscribe*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:120*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:133*
___
@@ -559,7 +563,7 @@ ___
*Inherited from IRouter.trace*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:121*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:134*
___
@@ -570,7 +574,7 @@ ___
*Inherited from IRouter.unlock*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:122*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:135*
___
@@ -581,7 +585,7 @@ ___
*Inherited from IRouter.unsubscribe*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:123*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:136*
___
@@ -594,7 +598,7 @@ ___
*Overrides IRouter.use*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1032*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1054*
___
@@ -605,7 +609,7 @@ ___
*Inherited from EventEmitter.defaultMaxListeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:8*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1011*
___
@@ -621,7 +625,7 @@ ___
*Overrides EventEmitter.addListener*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:10*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1013*
**Parameters:**
@@ -641,7 +645,7 @@ ___
*Inherited from Application.defaultConfiguration*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:871*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:893*
Initialize application configuration.
@@ -652,11 +656,11 @@ ___
### disable
-▸ **disable**(setting: *`string`*): `Application`
+▸ **disable**(setting: *`string`*): `this`
*Inherited from Application.disable*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:967*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:989*
Disable `setting`.
@@ -666,7 +670,7 @@ Disable `setting`.
| ------ | ------ |
| setting | `string` |
-**Returns:** `Application`
+**Returns:** `this`
___
@@ -677,7 +681,7 @@ ___
*Inherited from Application.disabled*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:961*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:983*
Check if `setting` is disabled.
@@ -704,7 +708,7 @@ ___
*Overrides EventEmitter.emit*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:22*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1025*
**Parameters:**
@@ -720,11 +724,11 @@ ___
### enable
-▸ **enable**(setting: *`string`*): `Application`
+▸ **enable**(setting: *`string`*): `this`
*Inherited from Application.enable*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:964*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:986*
Enable `setting`.
@@ -734,7 +738,7 @@ Enable `setting`.
| ------ | ------ |
| setting | `string` |
-**Returns:** `Application`
+**Returns:** `this`
___
@@ -745,7 +749,7 @@ ___
*Inherited from Application.enabled*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:949*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:971*
Check if `setting` is enabled (truthy).
@@ -766,11 +770,11 @@ ___
### engine
-▸ **engine**(ext: *`string`*, fn: *`function`*): `Application`
+▸ **engine**(ext: *`string`*, fn: *`function`*): `this`
*Inherited from Application.engine*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:901*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:923*
Register the given template engine callback `fn` as `ext`.
@@ -797,7 +801,7 @@ Some template engines do not follow this convention, the [Consolidate.js](https:
| ext | `string` |
| fn | `function` |
-**Returns:** `Application`
+**Returns:** `this`
___
@@ -810,7 +814,7 @@ ___
*Overrides EventEmitter.eventNames*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:23*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1026*
**Returns:** `Array`<`string` \| `symbol`>
@@ -825,7 +829,7 @@ ___
*Overrides EventEmitter.getMaxListeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:19*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1022*
**Returns:** `number`
@@ -838,7 +842,7 @@ ___
*Inherited from Application.init*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:866*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:888*
Initialize the server.
@@ -867,7 +871,7 @@ ___
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1000*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1022*
Listen for connections.
@@ -890,7 +894,7 @@ http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1001*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1023*
**Parameters:**
@@ -904,7 +908,7 @@ http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1002*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1024*
**Parameters:**
@@ -917,7 +921,7 @@ http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1003*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1025*
**Parameters:**
@@ -929,7 +933,7 @@ http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1004*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1026*
**Parameters:**
@@ -942,7 +946,7 @@ http.createServer(app).listen(80); https.createServer({ ... }, app).listen(443);
*Inherited from Application.listen*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1005*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1027*
**Parameters:**
@@ -964,7 +968,7 @@ ___
*Overrides EventEmitter.listenerCount*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:24*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1027*
**Parameters:**
@@ -985,7 +989,7 @@ ___
*Overrides EventEmitter.listeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:20*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1023*
**Parameters:**
@@ -1006,7 +1010,7 @@ ___
*Overrides EventEmitter.off*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:16*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1019*
**Parameters:**
@@ -1028,7 +1032,7 @@ ___
*Overrides EventEmitter.once*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:12*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1015*
**Parameters:**
@@ -1052,7 +1056,7 @@ ___
*Overrides IRouter.param*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:918*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:940*
**Parameters:**
@@ -1067,7 +1071,7 @@ ___
*Overrides IRouter.param*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:925*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:947*
Alternatively, you can pass only a callback, in which case you have the opportunity to alter the app.param()
@@ -1090,7 +1094,7 @@ ___
*Inherited from Application.path*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:937*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:959*
Return the app's absolute pathname based on the parent(s) that have mounted it.
@@ -1109,7 +1113,7 @@ ___
*Overrides EventEmitter.prependListener*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:13*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1016*
**Parameters:**
@@ -1131,7 +1135,7 @@ ___
*Overrides EventEmitter.prependOnceListener*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:14*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1017*
**Parameters:**
@@ -1153,7 +1157,7 @@ ___
*Overrides EventEmitter.rawListeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:21*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1024*
**Parameters:**
@@ -1174,7 +1178,7 @@ ___
*Overrides EventEmitter.removeAllListeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:17*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1020*
**Parameters:**
@@ -1195,7 +1199,7 @@ ___
*Overrides EventEmitter.removeListener*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:15*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1018*
**Parameters:**
@@ -1217,7 +1221,7 @@ ___
*Inherited from Application.render*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:980*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1002*
Render the given view `name` name with `options` and a callback accepting an error and the rendered template string.
@@ -1237,7 +1241,7 @@ app.render('email', { name: 'Tobi' }, function(err, html){ // ... })
*Inherited from Application.render*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:981*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:1003*
**Parameters:**
@@ -1257,7 +1261,7 @@ ___
*Inherited from IRouter.route*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:127*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:140*
**Parameters:**
@@ -1272,11 +1276,11 @@ ___
### set
-▸ **set**(setting: *`string`*, val: *`any`*): `Application`
+▸ **set**(setting: *`string`*, val: *`any`*): `this`
*Inherited from Application.set*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:915*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/express-serve-static-core/index.d.ts:937*
Assign `setting` to `val`, or return `setting`'s value.
@@ -1291,7 +1295,7 @@ Mounted servers inherit their parent server's settings.
| setting | `string` |
| val | `any` |
-**Returns:** `Application`
+**Returns:** `this`
___
@@ -1304,7 +1308,7 @@ ___
*Overrides EventEmitter.setMaxListeners*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:18*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1021*
**Parameters:**
@@ -1323,7 +1327,7 @@ ___
*Inherited from EventEmitter.listenerCount*
-*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/events.d.ts:7*
+*Defined in /Users/loicpoullain/projects/FoalTS/foal/packages/core/node_modules/@types/node/index.d.ts:1010*
*__deprecated__*: since v4.0.0
diff --git a/docs/api/core/interfaces/_express_create_app_.expressoptions.md b/docs/api/core/interfaces/_express_create_app_.expressoptions.md
index 5a360014d3..dc84c30853 100644
--- a/docs/api/core/interfaces/_express_create_app_.expressoptions.md
+++ b/docs/api/core/interfaces/_express_create_app_.expressoptions.md
@@ -24,25 +24,25 @@
**● expressInstance**: *[ExpressApplication](_express_create_app_.expressapplication.md)*
-*Defined in [express/create-app.ts:23](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-app.ts#L23)*
+*Defined in [express/create-app.ts:22](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-app.ts#L22)*
___
### `` postMiddlewares
-**● postMiddlewares**: *(`RequestHandler` \| `ErrorRequestHandler`)[]*
+**● postMiddlewares**: *(`RequestHandler`<`ParamsDictionary`> \| `ErrorRequestHandler`<`ParamsDictionary`>)[]*
-*Defined in [express/create-app.ts:25](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-app.ts#L25)*
+*Defined in [express/create-app.ts:24](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-app.ts#L24)*
___
### `` preMiddlewares
-**● preMiddlewares**: *(`RequestHandler` \| `ErrorRequestHandler`)[]*
+**● preMiddlewares**: *(`RequestHandler`<`ParamsDictionary`> \| `ErrorRequestHandler`<`ParamsDictionary`>)[]*
-*Defined in [express/create-app.ts:24](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-app.ts#L24)*
+*Defined in [express/create-app.ts:23](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-app.ts#L23)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractparameter.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractparameter.md
index 0ba4035983..6d8466f4ec 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractparameter.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractparameter.md
@@ -40,7 +40,7 @@
**● content**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L918)*
+*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L918)*
A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
@@ -55,7 +55,7 @@ ___
**● deprecated**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L847)*
+*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L847)*
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -72,7 +72,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L826)*
+*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L826)*
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -89,7 +89,7 @@ ___
**● example**: *`any`*
-*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L894)*
+*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L894)*
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
@@ -106,7 +106,7 @@ ___
**● examples**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L906)*
+*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L906)*
Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -121,7 +121,7 @@ ___
**● explode**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L871)*
+*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L871)*
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
@@ -138,7 +138,7 @@ ___
**● in**: *"query" \| "header" \| "path" \| "cookie"*
-*Defined in [openapi/interfaces.ts:816](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L816)*
+*Defined in [openapi/interfaces.ts:816](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L816)*
The location of the parameter. Possible values are "query", "header", "path" or "cookie".
@@ -155,7 +155,7 @@ ___
**● name**: *`string`*
-*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L807)*
+*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L807)*
The name of the parameter. Parameter names are case sensitive.
@@ -176,7 +176,7 @@ ___
**● required**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L837)*
+*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L837)*
Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
@@ -193,7 +193,7 @@ ___
**● schema**: *[IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L880)*
+*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L880)*
The schema defining the type used for the parameter.
@@ -210,7 +210,7 @@ ___
**● style**: *"matrix" \| "label" \| "form" \| "simple" \| "spaceDelimited" \| "pipeDelimited" \| "deepObject"*
-*Defined in [openapi/interfaces.ts:859](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L859)*
+*Defined in [openapi/interfaces.ts:859](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L859)*
Describes how the parameter value will be serialized depending on the type of the parameter value. Default values (based on value of in): for query - form; for path - simple; for header - simple; for cookie - form.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractsecurityscheme.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractsecurityscheme.md
index 0de73900d1..dc55048606 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractsecurityscheme.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiabstractsecurityscheme.md
@@ -31,7 +31,7 @@
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1876)*
+*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1876)*
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
@@ -48,7 +48,7 @@ ___
**● type**: *"apiKey" \| "http" \| "oauth2" \| "openIdConnect"*
-*Defined in [openapi/interfaces.ts:1866](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1866)*
+*Defined in [openapi/interfaces.ts:1866](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1866)*
The type of the security scheme. Valid values are "apiKey", "http", "oauth2", "openIdConnect".
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiapikeysecurityscheme.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiapikeysecurityscheme.md
index 0f1b7b4862..54806b0edb 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiapikeysecurityscheme.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiapikeysecurityscheme.md
@@ -29,7 +29,7 @@
*Inherited from [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[description](_openapi_interfaces_.iapiabstractsecurityscheme.md#description)*
-*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1876)*
+*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1876)*
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
@@ -46,7 +46,7 @@ ___
**● in**: *"query" \| "header" \| "cookie"*
-*Defined in [openapi/interfaces.ts:1898](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1898)*
+*Defined in [openapi/interfaces.ts:1898](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1898)*
The location of the API key. Valid values are "query", "header" or "cookie".
@@ -63,7 +63,7 @@ ___
**● name**: *`string`*
-*Defined in [openapi/interfaces.ts:1889](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1889)*
+*Defined in [openapi/interfaces.ts:1889](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1889)*
The name of the header, query or cookie parameter to be used.
@@ -82,7 +82,7 @@ ___
*Overrides [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[type](_openapi_interfaces_.iapiabstractsecurityscheme.md#type)*
-*Defined in [openapi/interfaces.ts:1880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1880)*
+*Defined in [openapi/interfaces.ts:1880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1880)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiauthorizationcodeoauthflow.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiauthorizationcodeoauthflow.md
index 27c0a14b49..93f27a6c33 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiauthorizationcodeoauthflow.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiauthorizationcodeoauthflow.md
@@ -27,7 +27,7 @@
**● authorizationUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2094](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2094)*
+*Defined in [openapi/interfaces.ts:2094](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2094)*
The authorization URL to be used for this flow. This MUST be in the form of a URL.
@@ -46,7 +46,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[refreshUrl](_openapi_interfaces_.iapioauthflow.md#refreshurl)*
-*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2032)*
+*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2032)*
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
@@ -65,7 +65,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[scopes](_openapi_interfaces_.iapioauthflow.md#scopes)*
-*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2044)*
+*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2044)*
The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.
@@ -86,7 +86,7 @@ ___
**● tokenUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2103](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2103)*
+*Defined in [openapi/interfaces.ts:2103](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2103)*
The token URL to be used for this flow. This MUST be in the form of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiclientcredentialsoauthflow.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiclientcredentialsoauthflow.md
index 1753edc909..2caa021eb8 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiclientcredentialsoauthflow.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiclientcredentialsoauthflow.md
@@ -28,7 +28,7 @@
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[refreshUrl](_openapi_interfaces_.iapioauthflow.md#refreshurl)*
-*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2032)*
+*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2032)*
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
@@ -47,7 +47,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[scopes](_openapi_interfaces_.iapioauthflow.md#scopes)*
-*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2044)*
+*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2044)*
The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.
@@ -68,7 +68,7 @@ ___
**● tokenUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2082](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2082)*
+*Defined in [openapi/interfaces.ts:2082](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2082)*
The token URL to be used for this flow. This MUST be in the form of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapicomponents.md b/docs/api/core/interfaces/_openapi_interfaces_.iapicomponents.md
index 5f53497146..f103277da2 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapicomponents.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapicomponents.md
@@ -38,7 +38,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● callbacks**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:447](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L447)*
+*Defined in [openapi/interfaces.ts:447](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L447)*
An object to hold reusable Callback Objects.
@@ -55,7 +55,7 @@ ___
**● examples**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:382](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L382)*
+*Defined in [openapi/interfaces.ts:382](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L382)*
An object to hold reusable Example Objects.
@@ -72,7 +72,7 @@ ___
**● headers**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:408](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L408)*
+*Defined in [openapi/interfaces.ts:408](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L408)*
An object to hold reusable Header Objects.
@@ -89,7 +89,7 @@ ___
**● links**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:434](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L434)*
+*Defined in [openapi/interfaces.ts:434](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L434)*
An object to hold reusable Link Objects.
@@ -106,7 +106,7 @@ ___
**● parameters**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:369](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L369)*
+*Defined in [openapi/interfaces.ts:369](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L369)*
An object to hold reusable Parameter Objects.
@@ -123,7 +123,7 @@ ___
**● requestBodies**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:395](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L395)*
+*Defined in [openapi/interfaces.ts:395](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L395)*
An object to hold reusable Request Body Objects.
@@ -140,7 +140,7 @@ ___
**● responses**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:356](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L356)*
+*Defined in [openapi/interfaces.ts:356](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L356)*
An object to hold reusable Response Objects.
@@ -157,7 +157,7 @@ ___
**● schemas**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:343](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L343)*
+*Defined in [openapi/interfaces.ts:343](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L343)*
An object to hold reusable Schema Objects.
@@ -174,7 +174,7 @@ ___
**● securitySchemes**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:421](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L421)*
+*Defined in [openapi/interfaces.ts:421](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L421)*
An object to hold reusable Security Scheme Objects.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapicontact.md b/docs/api/core/interfaces/_openapi_interfaces_.iapicontact.md
index b36be325bf..dfc6dafb84 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapicontact.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapicontact.md
@@ -32,7 +32,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● email**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:201](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L201)*
+*Defined in [openapi/interfaces.ts:201](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L201)*
The email address of the contact person/organization. MUST be in the format of an email address.
@@ -49,7 +49,7 @@ ___
**● name**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:182](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L182)*
+*Defined in [openapi/interfaces.ts:182](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L182)*
The identifying name of the contact person/organization.
@@ -66,7 +66,7 @@ ___
**● url**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:191](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L191)*
+*Defined in [openapi/interfaces.ts:191](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L191)*
The URL pointing to the contact information. MUST be in the format of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapicookieparameter.md b/docs/api/core/interfaces/_openapi_interfaces_.iapicookieparameter.md
index 1257041811..f023161fc9 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapicookieparameter.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapicookieparameter.md
@@ -36,7 +36,7 @@
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[content](_openapi_interfaces_.iapiabstractparameter.md#content)*
-*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L918)*
+*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L918)*
A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
@@ -53,7 +53,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[deprecated](_openapi_interfaces_.iapiabstractparameter.md#deprecated)*
-*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L847)*
+*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L847)*
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -72,7 +72,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[description](_openapi_interfaces_.iapiabstractparameter.md#description)*
-*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L826)*
+*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L826)*
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -91,7 +91,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[example](_openapi_interfaces_.iapiabstractparameter.md#example)*
-*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L894)*
+*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L894)*
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
@@ -110,7 +110,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[examples](_openapi_interfaces_.iapiabstractparameter.md#examples)*
-*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L906)*
+*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L906)*
Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -127,7 +127,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[explode](_openapi_interfaces_.iapiabstractparameter.md#explode)*
-*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L871)*
+*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L871)*
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
@@ -146,7 +146,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[in](_openapi_interfaces_.iapiabstractparameter.md#in)*
-*Defined in [openapi/interfaces.ts:964](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L964)*
+*Defined in [openapi/interfaces.ts:964](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L964)*
___
@@ -157,7 +157,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[name](_openapi_interfaces_.iapiabstractparameter.md#name)*
-*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L807)*
+*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L807)*
The name of the parameter. Parameter names are case sensitive.
@@ -180,7 +180,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[required](_openapi_interfaces_.iapiabstractparameter.md#required)*
-*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L837)*
+*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L837)*
Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
@@ -199,7 +199,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[schema](_openapi_interfaces_.iapiabstractparameter.md#schema)*
-*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L880)*
+*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L880)*
The schema defining the type used for the parameter.
@@ -218,7 +218,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[style](_openapi_interfaces_.iapiabstractparameter.md#style)*
-*Defined in [openapi/interfaces.ts:965](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L965)*
+*Defined in [openapi/interfaces.ts:965](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L965)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapidiscriminator.md b/docs/api/core/interfaces/_openapi_interfaces_.iapidiscriminator.md
index 60109a0aba..7de2f76568 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapidiscriminator.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapidiscriminator.md
@@ -33,7 +33,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● mapping**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1784](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1784)*
+*Defined in [openapi/interfaces.ts:1784](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1784)*
An object to hold mappings between payload values and schema names or references.
@@ -50,7 +50,7 @@ ___
**● propertyName**: *`string`*
-*Defined in [openapi/interfaces.ts:1773](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1773)*
+*Defined in [openapi/interfaces.ts:1773](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1773)*
The name of the property in the payload that will hold the discriminator value.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiencoding.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiencoding.md
index aac257c7c9..536687bca0 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiencoding.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiencoding.md
@@ -34,7 +34,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● allowReserved**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1177](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1177)*
+*Defined in [openapi/interfaces.ts:1177](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1177)*
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#\[\]@!$&'()\*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
@@ -51,7 +51,7 @@ ___
**● contentType**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1124](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1124)*
+*Defined in [openapi/interfaces.ts:1124](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1124)*
The Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/\*), or a comma-separated list of the two types.
@@ -68,7 +68,7 @@ ___
**● explode**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1165](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1165)*
+*Defined in [openapi/interfaces.ts:1165](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1165)*
When this is true, property values of type array or object generate separate parameters for each value of the array, or key-value-pair of the map. For other types of properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
@@ -85,7 +85,7 @@ ___
**● headers**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1138](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1138)*
+*Defined in [openapi/interfaces.ts:1138](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1138)*
A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart.
@@ -102,7 +102,7 @@ ___
**● style**: *"matrix" \| "label" \| "form" \| "simple" \| "spaceDelimited" \| "pipeDelimited" \| "deepObject"*
-*Defined in [openapi/interfaces.ts:1152](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1152)*
+*Defined in [openapi/interfaces.ts:1152](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1152)*
Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiexample.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiexample.md
index 317095ca04..45e26cb3f7 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiexample.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiexample.md
@@ -25,7 +25,7 @@
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1427](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1427)*
+*Defined in [openapi/interfaces.ts:1427](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1427)*
Long description for the example. CommonMark syntax MAY be used for rich text representation.
@@ -42,7 +42,7 @@ ___
**● externalValue**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1449](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1449)*
+*Defined in [openapi/interfaces.ts:1449](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1449)*
A URL that points to the literal example. This provides the capability to reference examples that cannot easily be included in JSON or YAML documents. The value field and externalValue field are mutually exclusive.
@@ -59,7 +59,7 @@ ___
**● summary**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1417](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1417)*
+*Defined in [openapi/interfaces.ts:1417](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1417)*
Short description for the example.
@@ -76,7 +76,7 @@ ___
**● value**: *`any`*
-*Defined in [openapi/interfaces.ts:1438](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1438)*
+*Defined in [openapi/interfaces.ts:1438](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1438)*
Embedded literal example. The value field and externalValue field are mutually exclusive. To represent examples of media types that cannot naturally represented in JSON or YAML, use a string value to contain the example, escaping where necessary.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiexternaldocumentation.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiexternaldocumentation.md
index 629a2211b7..bff099a3b7 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiexternaldocumentation.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiexternaldocumentation.md
@@ -31,7 +31,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:781](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L781)*
+*Defined in [openapi/interfaces.ts:781](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L781)*
A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.
@@ -48,7 +48,7 @@ ___
**● url**: *`string`*
-*Defined in [openapi/interfaces.ts:790](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L790)*
+*Defined in [openapi/interfaces.ts:790](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L790)*
The URL for the target documentation. Value MUST be in the format of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiheaderparameter.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiheaderparameter.md
index c856e568dc..4d490e0775 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiheaderparameter.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiheaderparameter.md
@@ -36,7 +36,7 @@
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[content](_openapi_interfaces_.iapiabstractparameter.md#content)*
-*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L918)*
+*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L918)*
A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
@@ -53,7 +53,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[deprecated](_openapi_interfaces_.iapiabstractparameter.md#deprecated)*
-*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L847)*
+*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L847)*
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -72,7 +72,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[description](_openapi_interfaces_.iapiabstractparameter.md#description)*
-*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L826)*
+*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L826)*
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -91,7 +91,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[example](_openapi_interfaces_.iapiabstractparameter.md#example)*
-*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L894)*
+*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L894)*
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
@@ -110,7 +110,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[examples](_openapi_interfaces_.iapiabstractparameter.md#examples)*
-*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L906)*
+*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L906)*
Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -127,7 +127,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[explode](_openapi_interfaces_.iapiabstractparameter.md#explode)*
-*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L871)*
+*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L871)*
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
@@ -146,7 +146,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[in](_openapi_interfaces_.iapiabstractparameter.md#in)*
-*Defined in [openapi/interfaces.ts:959](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L959)*
+*Defined in [openapi/interfaces.ts:959](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L959)*
___
@@ -157,7 +157,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[name](_openapi_interfaces_.iapiabstractparameter.md#name)*
-*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L807)*
+*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L807)*
The name of the parameter. Parameter names are case sensitive.
@@ -180,7 +180,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[required](_openapi_interfaces_.iapiabstractparameter.md#required)*
-*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L837)*
+*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L837)*
Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
@@ -199,7 +199,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[schema](_openapi_interfaces_.iapiabstractparameter.md#schema)*
-*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L880)*
+*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L880)*
The schema defining the type used for the parameter.
@@ -218,7 +218,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[style](_openapi_interfaces_.iapiabstractparameter.md#style)*
-*Defined in [openapi/interfaces.ts:960](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L960)*
+*Defined in [openapi/interfaces.ts:960](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L960)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapihttpsecurityscheme.md b/docs/api/core/interfaces/_openapi_interfaces_.iapihttpsecurityscheme.md
index 7a7d06dd1f..76252d99c9 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapihttpsecurityscheme.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapihttpsecurityscheme.md
@@ -27,7 +27,7 @@
**● bearerFormat**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1923](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1923)*
+*Defined in [openapi/interfaces.ts:1923](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1923)*
A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
@@ -46,7 +46,7 @@ ___
*Inherited from [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[description](_openapi_interfaces_.iapiabstractsecurityscheme.md#description)*
-*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1876)*
+*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1876)*
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
@@ -63,7 +63,7 @@ ___
**● scheme**: *`string`*
-*Defined in [openapi/interfaces.ts:1912](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1912)*
+*Defined in [openapi/interfaces.ts:1912](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1912)*
The name of the HTTP Authorization scheme to be used in the Authorization header as defined in RFC7235.
@@ -82,7 +82,7 @@ ___
*Overrides [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[type](_openapi_interfaces_.iapiabstractsecurityscheme.md#type)*
-*Defined in [openapi/interfaces.ts:1902](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1902)*
+*Defined in [openapi/interfaces.ts:1902](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1902)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiimplicitoauthflow.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiimplicitoauthflow.md
index 5c054bc201..056b65cb6e 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiimplicitoauthflow.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiimplicitoauthflow.md
@@ -26,7 +26,7 @@
**● authorizationUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2058](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2058)*
+*Defined in [openapi/interfaces.ts:2058](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2058)*
The authorization URL to be used for this flow. This MUST be in the form of a URL.
@@ -45,7 +45,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[refreshUrl](_openapi_interfaces_.iapioauthflow.md#refreshurl)*
-*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2032)*
+*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2032)*
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
@@ -64,7 +64,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[scopes](_openapi_interfaces_.iapioauthflow.md#scopes)*
-*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2044)*
+*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2044)*
The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiinfo.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiinfo.md
index 025ae8079e..2f40d1baca 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiinfo.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiinfo.md
@@ -35,7 +35,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● contact**: *[IApiContact](_openapi_interfaces_.iapicontact.md)*
-*Defined in [openapi/interfaces.ts:143](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L143)*
+*Defined in [openapi/interfaces.ts:143](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L143)*
The contact information for the exposed API.
@@ -52,7 +52,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:125](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L125)*
+*Defined in [openapi/interfaces.ts:125](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L125)*
A short description of the application. CommonMark syntax MAY be used for rich text representation.
@@ -69,7 +69,7 @@ ___
**● license**: *[IApiLicense](_openapi_interfaces_.iapilicense.md)*
-*Defined in [openapi/interfaces.ts:152](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L152)*
+*Defined in [openapi/interfaces.ts:152](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L152)*
The license information for the exposed API.
@@ -86,7 +86,7 @@ ___
**● termsOfService**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:134](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L134)*
+*Defined in [openapi/interfaces.ts:134](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L134)*
A URL to the Terms of Service for the API. MUST be in the format of a URL.
@@ -103,7 +103,7 @@ ___
**● title**: *`string`*
-*Defined in [openapi/interfaces.ts:115](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L115)*
+*Defined in [openapi/interfaces.ts:115](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L115)*
The title of the application.
@@ -120,7 +120,7 @@ ___
**● version**: *`string`*
-*Defined in [openapi/interfaces.ts:162](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L162)*
+*Defined in [openapi/interfaces.ts:162](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L162)*
The version of the OpenAPI document (which is distinct from the OpenAPI Specification version or the API implementation version).
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapilicense.md b/docs/api/core/interfaces/_openapi_interfaces_.iapilicense.md
index ddf1584165..2397dc96b2 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapilicense.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapilicense.md
@@ -31,7 +31,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● name**: *`string`*
-*Defined in [openapi/interfaces.ts:221](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L221)*
+*Defined in [openapi/interfaces.ts:221](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L221)*
The license name used for the API.
@@ -48,7 +48,7 @@ ___
**● url**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:230](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L230)*
+*Defined in [openapi/interfaces.ts:230](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L230)*
A URL to the license used for the API. MUST be in the format of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapilink.md b/docs/api/core/interfaces/_openapi_interfaces_.iapilink.md
index 87cedeeec0..b4be419632 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapilink.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapilink.md
@@ -39,7 +39,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1525](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1525)*
+*Defined in [openapi/interfaces.ts:1525](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1525)*
A description of the link. CommonMark syntax MAY be used for rich text representation.
@@ -56,7 +56,7 @@ ___
**● operationId**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1490](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1490)*
+*Defined in [openapi/interfaces.ts:1490](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1490)*
The name of an existing, resolvable OAS operation, as defined with a unique operationId. This field is mutually exclusive of the operationRef field.
@@ -73,7 +73,7 @@ ___
**● operationRef**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1480](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1480)*
+*Defined in [openapi/interfaces.ts:1480](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1480)*
A relative or absolute reference to an OAS operation. This field is mutually exclusive of the operationId field, and MUST point to an Operation Object. Relative operationRef values MAY be used to locate an existing Operation Object in the OpenAPI definition.
@@ -90,7 +90,7 @@ ___
**● parameters**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1505](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1505)*
+*Defined in [openapi/interfaces.ts:1505](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1505)*
A map representing parameters to pass to an operation as specified with operationId or identified via operationRef. The key is the parameter name to be used, whereas the value can be a constant or an expression to be evaluated and passed to the linked operation. The parameter name can be qualified using the parameter location \[{in}.\]{name} for operations that use the same parameter name in different locations (e.g. path.id).
@@ -107,7 +107,7 @@ ___
**● requestBody**: *`any` \| `string`*
-*Defined in [openapi/interfaces.ts:1516](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1516)*
+*Defined in [openapi/interfaces.ts:1516](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1516)*
A literal value or {expression} to use as a request body when calling the target operation.
@@ -124,7 +124,7 @@ ___
**● server**: *[IApiServer](_openapi_interfaces_.iapiserver.md)*
-*Defined in [openapi/interfaces.ts:1534](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1534)*
+*Defined in [openapi/interfaces.ts:1534](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1534)*
A server object to be used by the target operation.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapimediatype.md b/docs/api/core/interfaces/_openapi_interfaces_.iapimediatype.md
index 4659969d6b..e55ab25574 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapimediatype.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapimediatype.md
@@ -33,7 +33,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● encoding**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1097](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1097)*
+*Defined in [openapi/interfaces.ts:1097](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1097)*
A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded.
@@ -50,7 +50,7 @@ ___
**● example**: *`any`*
-*Defined in [openapi/interfaces.ts:1067](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1067)*
+*Defined in [openapi/interfaces.ts:1067](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1067)*
Example of the media type. The example object SHOULD be in the correct format as specified by the media type. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema.
@@ -67,7 +67,7 @@ ___
**● examples**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1081](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1081)*
+*Defined in [openapi/interfaces.ts:1081](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1081)*
Examples of the media type. Each example object SHOULD match the media type and specified schema if present. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -84,7 +84,7 @@ ___
**● schema**: *[IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1054](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1054)*
+*Defined in [openapi/interfaces.ts:1054](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1054)*
The schema defining the content of the request, response, or parameter.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapioauth2securityscheme.md b/docs/api/core/interfaces/_openapi_interfaces_.iapioauth2securityscheme.md
index f1fa68e72b..fdc078e17c 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapioauth2securityscheme.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapioauth2securityscheme.md
@@ -28,7 +28,7 @@
*Inherited from [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[description](_openapi_interfaces_.iapiabstractsecurityscheme.md#description)*
-*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1876)*
+*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1876)*
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
@@ -45,7 +45,7 @@ ___
**● flows**: *[IApiOAuthFlows](_openapi_interfaces_.iapioauthflows.md)*
-*Defined in [openapi/interfaces.ts:1936](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1936)*
+*Defined in [openapi/interfaces.ts:1936](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1936)*
An object containing configuration information for the flow types supported.
@@ -64,7 +64,7 @@ ___
*Overrides [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[type](_openapi_interfaces_.iapiabstractsecurityscheme.md#type)*
-*Defined in [openapi/interfaces.ts:1927](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1927)*
+*Defined in [openapi/interfaces.ts:1927](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1927)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflow.md b/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflow.md
index 089a117c99..601e86c3ff 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflow.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflow.md
@@ -39,7 +39,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● refreshUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2032)*
+*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2032)*
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
@@ -56,7 +56,7 @@ ___
**● scopes**: *`object`*
-*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2044)*
+*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2044)*
The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflows.md b/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflows.md
index 5f68060196..73697d320a 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflows.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapioauthflows.md
@@ -33,7 +33,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● authorizationCode**: *[IApiAuthorizationCodeOAuthFlow](_openapi_interfaces_.iapiauthorizationcodeoauthflow.md)*
-*Defined in [openapi/interfaces.ts:2012](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2012)*
+*Defined in [openapi/interfaces.ts:2012](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2012)*
Configuration for the OAuth Authorization Code flow. Previously called accessCode in OpenAPI 2.0.
@@ -50,7 +50,7 @@ ___
**● clientCredentials**: *[IApiClientCredentialsOAuthFlow](_openapi_interfaces_.iapiclientcredentialsoauthflow.md)*
-*Defined in [openapi/interfaces.ts:2002](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2002)*
+*Defined in [openapi/interfaces.ts:2002](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2002)*
Configuration for the OAuth Client Credentials flow. Previously called application in OpenAPI 2.0.
@@ -67,7 +67,7 @@ ___
**● implicit**: *[IApiImplicitOAuthFlow](_openapi_interfaces_.iapiimplicitoauthflow.md)*
-*Defined in [openapi/interfaces.ts:1983](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1983)*
+*Defined in [openapi/interfaces.ts:1983](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1983)*
Configuration for the OAuth Implicit flow
@@ -84,7 +84,7 @@ ___
**● password**: *[IApiPasswordOAuthFlow](_openapi_interfaces_.iapipasswordoauthflow.md)*
-*Defined in [openapi/interfaces.ts:1992](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1992)*
+*Defined in [openapi/interfaces.ts:1992](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1992)*
Configuration for the OAuth Resource Owner Password flow
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiopenidconnectsecurityscheme.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiopenidconnectsecurityscheme.md
index 25f601c2f3..c95ce763cf 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiopenidconnectsecurityscheme.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiopenidconnectsecurityscheme.md
@@ -28,7 +28,7 @@
*Inherited from [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[description](_openapi_interfaces_.iapiabstractsecurityscheme.md#description)*
-*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1876)*
+*Defined in [openapi/interfaces.ts:1876](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1876)*
A short description for security scheme. CommonMark syntax MAY be used for rich text representation.
@@ -45,7 +45,7 @@ ___
**● openIdConnectUrl**: *`string`*
-*Defined in [openapi/interfaces.ts:1950](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1950)*
+*Defined in [openapi/interfaces.ts:1950](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1950)*
OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL.
@@ -64,7 +64,7 @@ ___
*Overrides [IApiAbstractSecurityScheme](_openapi_interfaces_.iapiabstractsecurityscheme.md).[type](_openapi_interfaces_.iapiabstractsecurityscheme.md#type)*
-*Defined in [openapi/interfaces.ts:1940](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1940)*
+*Defined in [openapi/interfaces.ts:1940](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1940)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapioperation.md b/docs/api/core/interfaces/_openapi_interfaces_.iapioperation.md
index adb2df25df..14c931b41d 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapioperation.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapioperation.md
@@ -41,7 +41,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● callbacks**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:725](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L725)*
+*Defined in [openapi/interfaces.ts:725](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L725)*
A map of possible out-of band callbacks related to the parent operation. The key is a unique identifier for the Callback Object. Each value in the map is a Callback Object that describes a request that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.
@@ -58,7 +58,7 @@ ___
**● deprecated**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:737](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L737)*
+*Defined in [openapi/interfaces.ts:737](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L737)*
Declares this operation to be deprecated. Consumers SHOULD refrain from usage of the declared operation. Default value is false.
@@ -75,7 +75,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:655](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L655)*
+*Defined in [openapi/interfaces.ts:655](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L655)*
A verbose explanation of the operation behavior. CommonMark syntax MAY be used for rich text representation.
@@ -92,7 +92,7 @@ ___
**● externalDocs**: *[IApiExternalDocumentation](_openapi_interfaces_.iapiexternaldocumentation.md)*
-*Defined in [openapi/interfaces.ts:664](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L664)*
+*Defined in [openapi/interfaces.ts:664](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L664)*
Additional external documentation for this operation.
@@ -109,7 +109,7 @@ ___
**● operationId**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:676](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L676)*
+*Defined in [openapi/interfaces.ts:676](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L676)*
Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.
@@ -126,7 +126,7 @@ ___
**● parameters**: *([IApiReference](_openapi_interfaces_.iapireference.md) \| [IApiPathParameter](_openapi_interfaces_.iapipathparameter.md) \| [IApiQueryParameter](_openapi_interfaces_.iapiqueryparameter.md) \| [IApiHeaderParameter](_openapi_interfaces_.iapiheaderparameter.md) \| [IApiCookieParameter](_openapi_interfaces_.iapicookieparameter.md))[]*
-*Defined in [openapi/interfaces.ts:689](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L689)*
+*Defined in [openapi/interfaces.ts:689](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L689)*
A list of parameters that are applicable for this operation. If a parameter is already defined at the Path Item, the new definition will override it but can never remove it. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
@@ -143,7 +143,7 @@ ___
**● requestBody**: *[IApiRequestBody](_openapi_interfaces_.iapirequestbody.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:701](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L701)*
+*Defined in [openapi/interfaces.ts:701](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L701)*
The request body applicable for this operation. The requestBody is only supported in HTTP methods where the HTTP 1.1 specification RFC7231 has explicitly defined semantics for request bodies. In other cases where the HTTP spec is vague, requestBody SHALL be ignored by consumers.
@@ -160,7 +160,7 @@ ___
**● responses**: *[IApiResponses](_openapi_interfaces_.iapiresponses.md)*
-*Defined in [openapi/interfaces.ts:710](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L710)*
+*Defined in [openapi/interfaces.ts:710](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L710)*
The list of possible responses as they are returned from executing this operation.
@@ -177,7 +177,7 @@ ___
**● security**: *[IApiSecurityRequirement](_openapi_interfaces_.iapisecurityrequirement.md)[]*
-*Defined in [openapi/interfaces.ts:750](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L750)*
+*Defined in [openapi/interfaces.ts:750](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L750)*
A declaration of which security mechanisms can be used for this operation. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. This definition overrides any declared top-level security. To remove a top-level security declaration, an empty array can be used.
@@ -194,7 +194,7 @@ ___
**● servers**: *[IApiServer](_openapi_interfaces_.iapiserver.md)[]*
-*Defined in [openapi/interfaces.ts:760](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L760)*
+*Defined in [openapi/interfaces.ts:760](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L760)*
An alternative server array to service this operation. If an alternative server object is specified at the Path Item Object or Root level, it will be overridden by this value.
@@ -211,7 +211,7 @@ ___
**● summary**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:645](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L645)*
+*Defined in [openapi/interfaces.ts:645](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L645)*
A short summary of what the operation does.
@@ -228,7 +228,7 @@ ___
**● tags**: *`string`[]*
-*Defined in [openapi/interfaces.ts:636](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L636)*
+*Defined in [openapi/interfaces.ts:636](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L636)*
A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapipasswordoauthflow.md b/docs/api/core/interfaces/_openapi_interfaces_.iapipasswordoauthflow.md
index 44acad4f40..84248baa10 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapipasswordoauthflow.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapipasswordoauthflow.md
@@ -28,7 +28,7 @@
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[refreshUrl](_openapi_interfaces_.iapioauthflow.md#refreshurl)*
-*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2032)*
+*Defined in [openapi/interfaces.ts:2032](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2032)*
The URL to be used for obtaining refresh tokens. This MUST be in the form of a URL.
@@ -47,7 +47,7 @@ ___
*Inherited from [IApiOAuthFlow](_openapi_interfaces_.iapioauthflow.md).[scopes](_openapi_interfaces_.iapioauthflow.md#scopes)*
-*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2044)*
+*Defined in [openapi/interfaces.ts:2044](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2044)*
The available scopes for the OAuth2 security scheme. A map between the scope name and a short description for it.
@@ -68,7 +68,7 @@ ___
**● tokenUrl**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:2070](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L2070)*
+*Defined in [openapi/interfaces.ts:2070](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L2070)*
The token URL to be used for this flow. This MUST be in the form of a URL.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapipathitem.md b/docs/api/core/interfaces/_openapi_interfaces_.iapipathitem.md
index 2b9baa78d2..18e33d5bd9 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapipathitem.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapipathitem.md
@@ -42,7 +42,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● $ref**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:501](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L501)*
+*Defined in [openapi/interfaces.ts:501](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L501)*
Allows for an external definition of this path item. The referenced structure MUST be in the format of a Path Item Object. If there are conflicts between the referenced definition and this Path Item's definition, the behavior is _undefined_.
@@ -59,7 +59,7 @@ ___
**● delete**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:556](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L556)*
+*Defined in [openapi/interfaces.ts:556](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L556)*
A definition of a DELETE operation on this path.
@@ -76,7 +76,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:520](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L520)*
+*Defined in [openapi/interfaces.ts:520](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L520)*
An optional, string description, intended to apply to all operations in this path. CommonMark syntax MAY be used for rich text representation.
@@ -93,7 +93,7 @@ ___
**● get**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:529](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L529)*
+*Defined in [openapi/interfaces.ts:529](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L529)*
A definition of a GET operation on this path.
@@ -110,7 +110,7 @@ ___
**● head**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:574](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L574)*
+*Defined in [openapi/interfaces.ts:574](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L574)*
A definition of a HEAD operation on this path.
@@ -127,7 +127,7 @@ ___
**● options**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:565](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L565)*
+*Defined in [openapi/interfaces.ts:565](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L565)*
A definition of a OPTIONS operation on this path.
@@ -144,7 +144,7 @@ ___
**● parameters**: *([IApiReference](_openapi_interfaces_.iapireference.md) \| [IApiPathParameter](_openapi_interfaces_.iapipathparameter.md) \| [IApiQueryParameter](_openapi_interfaces_.iapiqueryparameter.md) \| [IApiHeaderParameter](_openapi_interfaces_.iapiheaderparameter.md) \| [IApiCookieParameter](_openapi_interfaces_.iapicookieparameter.md))[]*
-*Defined in [openapi/interfaces.ts:615](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L615)*
+*Defined in [openapi/interfaces.ts:615](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L615)*
A list of parameters that are applicable for all the operations described under this path. These parameters can be overridden at the operation level, but cannot be removed there. The list MUST NOT include duplicated parameters. A unique parameter is defined by a combination of a name and location. The list can use the Reference Object to link to parameters that are defined at the OpenAPI Object's components/parameters.
@@ -161,7 +161,7 @@ ___
**● patch**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:583](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L583)*
+*Defined in [openapi/interfaces.ts:583](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L583)*
A definition of a PATCH operation on this path.
@@ -178,7 +178,7 @@ ___
**● post**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:547](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L547)*
+*Defined in [openapi/interfaces.ts:547](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L547)*
A definition of a POST operation on this path.
@@ -195,7 +195,7 @@ ___
**● put**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:538](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L538)*
+*Defined in [openapi/interfaces.ts:538](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L538)*
A definition of a PUT operation on this path.
@@ -212,7 +212,7 @@ ___
**● servers**: *[IApiServer](_openapi_interfaces_.iapiserver.md)[]*
-*Defined in [openapi/interfaces.ts:601](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L601)*
+*Defined in [openapi/interfaces.ts:601](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L601)*
An alternative server array to service all operations in this path.
@@ -229,7 +229,7 @@ ___
**● summary**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:510](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L510)*
+*Defined in [openapi/interfaces.ts:510](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L510)*
An optional, string summary, intended to apply to all operations in this path.
@@ -246,7 +246,7 @@ ___
**● trace**: *[IApiOperation](_openapi_interfaces_.iapioperation.md)*
-*Defined in [openapi/interfaces.ts:592](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L592)*
+*Defined in [openapi/interfaces.ts:592](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L592)*
A definition of a TRACE operation on this path.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapipathparameter.md b/docs/api/core/interfaces/_openapi_interfaces_.iapipathparameter.md
index 9e76736374..4b36e1c6ef 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapipathparameter.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapipathparameter.md
@@ -36,7 +36,7 @@
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[content](_openapi_interfaces_.iapiabstractparameter.md#content)*
-*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L918)*
+*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L918)*
A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
@@ -53,7 +53,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[deprecated](_openapi_interfaces_.iapiabstractparameter.md#deprecated)*
-*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L847)*
+*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L847)*
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -72,7 +72,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[description](_openapi_interfaces_.iapiabstractparameter.md#description)*
-*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L826)*
+*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L826)*
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -91,7 +91,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[example](_openapi_interfaces_.iapiabstractparameter.md#example)*
-*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L894)*
+*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L894)*
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
@@ -110,7 +110,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[examples](_openapi_interfaces_.iapiabstractparameter.md#examples)*
-*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L906)*
+*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L906)*
Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -127,7 +127,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[explode](_openapi_interfaces_.iapiabstractparameter.md#explode)*
-*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L871)*
+*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L871)*
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
@@ -146,7 +146,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[in](_openapi_interfaces_.iapiabstractparameter.md#in)*
-*Defined in [openapi/interfaces.ts:924](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L924)*
+*Defined in [openapi/interfaces.ts:924](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L924)*
___
@@ -157,7 +157,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[name](_openapi_interfaces_.iapiabstractparameter.md#name)*
-*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L807)*
+*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L807)*
The name of the parameter. Parameter names are case sensitive.
@@ -180,7 +180,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[required](_openapi_interfaces_.iapiabstractparameter.md#required)*
-*Defined in [openapi/interfaces.ts:925](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L925)*
+*Defined in [openapi/interfaces.ts:925](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L925)*
___
@@ -191,7 +191,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[schema](_openapi_interfaces_.iapiabstractparameter.md#schema)*
-*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L880)*
+*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L880)*
The schema defining the type used for the parameter.
@@ -210,7 +210,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[style](_openapi_interfaces_.iapiabstractparameter.md#style)*
-*Defined in [openapi/interfaces.ts:926](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L926)*
+*Defined in [openapi/interfaces.ts:926](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L926)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiqueryparameter.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiqueryparameter.md
index 3051dad812..7619fddb72 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiqueryparameter.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiqueryparameter.md
@@ -36,7 +36,7 @@
**● allowEmptyValue**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:943](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L943)*
+*Defined in [openapi/interfaces.ts:943](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L943)*
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. Default value is false. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
@@ -53,7 +53,7 @@ ___
**● allowReserved**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:954](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L954)*
+*Defined in [openapi/interfaces.ts:954](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L954)*
Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#\[\]@!$&'()\*+,;= to be included without percent-encoding. This property only applies to parameters with an in value of query. The default value is false.
@@ -72,7 +72,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[content](_openapi_interfaces_.iapiabstractparameter.md#content)*
-*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L918)*
+*Defined in [openapi/interfaces.ts:918](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L918)*
A map containing the representations for the parameter. The key is the media type and the value describes it. The map MUST only contain one entry.
@@ -89,7 +89,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[deprecated](_openapi_interfaces_.iapiabstractparameter.md#deprecated)*
-*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L847)*
+*Defined in [openapi/interfaces.ts:847](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L847)*
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -108,7 +108,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[description](_openapi_interfaces_.iapiabstractparameter.md#description)*
-*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L826)*
+*Defined in [openapi/interfaces.ts:826](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L826)*
A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -127,7 +127,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[example](_openapi_interfaces_.iapiabstractparameter.md#example)*
-*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L894)*
+*Defined in [openapi/interfaces.ts:894](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L894)*
Example of the media type. The example SHOULD match the specified schema and encoding properties if present. The example field is mutually exclusive of the examples field. Furthermore, if referencing a schema which contains an example, the example value SHALL override the example provided by the schema. To represent examples of media types that cannot naturally be represented in JSON or YAML, a string value can contain the example with escaping where necessary.
@@ -146,7 +146,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[examples](_openapi_interfaces_.iapiabstractparameter.md#examples)*
-*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L906)*
+*Defined in [openapi/interfaces.ts:906](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L906)*
Examples of the media type. Each example SHOULD contain a value in the correct format as specified in the parameter encoding. The examples field is mutually exclusive of the example field. Furthermore, if referencing a schema which contains an example, the examples value SHALL override the example provided by the schema.
@@ -163,7 +163,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[explode](_openapi_interfaces_.iapiabstractparameter.md#explode)*
-*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L871)*
+*Defined in [openapi/interfaces.ts:871](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L871)*
When this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
@@ -182,7 +182,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[in](_openapi_interfaces_.iapiabstractparameter.md#in)*
-*Defined in [openapi/interfaces.ts:930](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L930)*
+*Defined in [openapi/interfaces.ts:930](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L930)*
___
@@ -193,7 +193,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[name](_openapi_interfaces_.iapiabstractparameter.md#name)*
-*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L807)*
+*Defined in [openapi/interfaces.ts:807](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L807)*
The name of the parameter. Parameter names are case sensitive.
@@ -216,7 +216,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[required](_openapi_interfaces_.iapiabstractparameter.md#required)*
-*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L837)*
+*Defined in [openapi/interfaces.ts:837](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L837)*
Determines whether this parameter is mandatory. If the parameter location is "path", this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
@@ -235,7 +235,7 @@ ___
*Inherited from [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[schema](_openapi_interfaces_.iapiabstractparameter.md#schema)*
-*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L880)*
+*Defined in [openapi/interfaces.ts:880](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L880)*
The schema defining the type used for the parameter.
@@ -254,7 +254,7 @@ ___
*Overrides [IApiAbstractParameter](_openapi_interfaces_.iapiabstractparameter.md).[style](_openapi_interfaces_.iapiabstractparameter.md#style)*
-*Defined in [openapi/interfaces.ts:955](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L955)*
+*Defined in [openapi/interfaces.ts:955](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L955)*
___
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapireference.md b/docs/api/core/interfaces/_openapi_interfaces_.iapireference.md
index e989c0aa4d..eac3bc0e50 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapireference.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapireference.md
@@ -34,7 +34,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● $ref**: *`string`*
-*Defined in [openapi/interfaces.ts:1616](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1616)*
+*Defined in [openapi/interfaces.ts:1616](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1616)*
The reference string.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapirequestbody.md b/docs/api/core/interfaces/_openapi_interfaces_.iapirequestbody.md
index b996e974a2..041e3b209c 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapirequestbody.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapirequestbody.md
@@ -32,7 +32,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● content**: *`object`*
-*Defined in [openapi/interfaces.ts:1022](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1022)*
+*Defined in [openapi/interfaces.ts:1022](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1022)*
The content of the request body. The key is a media type or media type range and the value describes it. For requests that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\*
@@ -53,7 +53,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1009](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1009)*
+*Defined in [openapi/interfaces.ts:1009](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1009)*
A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
@@ -70,7 +70,7 @@ ___
**● required**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1033](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1033)*
+*Defined in [openapi/interfaces.ts:1033](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1033)*
Determines if the request body is required in the request. Defaults to false.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiresponse.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiresponse.md
index f4f58ada7d..87196b6956 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiresponse.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiresponse.md
@@ -33,7 +33,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● content**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1363](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1363)*
+*Defined in [openapi/interfaces.ts:1363](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1363)*
A map containing descriptions of potential response payloads. The key is a media type or media type range and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/\*
@@ -50,7 +50,7 @@ ___
**● description**: *`string`*
-*Defined in [openapi/interfaces.ts:1334](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1334)*
+*Defined in [openapi/interfaces.ts:1334](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1334)*
A short description of the response. CommonMark syntax MAY be used for rich text representation.
@@ -67,7 +67,7 @@ ___
**● headers**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1347](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1347)*
+*Defined in [openapi/interfaces.ts:1347](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1347)*
Maps a header name to its definition. RFC7230 states header names are case insensitive. If a response header is defined with the name "Content-Type", it SHALL be ignored.
@@ -84,7 +84,7 @@ ___
**● links**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1378](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1378)*
+*Defined in [openapi/interfaces.ts:1378](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1378)*
A map of operations links that can be followed from the response. The key of the map is a short name for the link, following the naming constraints of the names for Component Objects.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiresponses.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiresponses.md
index 779d19fbf0..26402fe67a 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiresponses.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiresponses.md
@@ -52,7 +52,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● 1XX**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1244](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1244)*
+*Defined in [openapi/interfaces.ts:1244](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1244)*
Any HTTP status code can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A Reference Object can link to a response that is defined in the OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character X. For example, 2XX represents all response codes between \[200-299\]. Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.
@@ -69,7 +69,7 @@ ___
**● 2XX**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1261](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1261)*
+*Defined in [openapi/interfaces.ts:1261](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1261)*
Any HTTP status code can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A Reference Object can link to a response that is defined in the OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character X. For example, 2XX represents all response codes between \[200-299\]. Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.
@@ -86,7 +86,7 @@ ___
**● 3XX**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1278](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1278)*
+*Defined in [openapi/interfaces.ts:1278](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1278)*
Any HTTP status code can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A Reference Object can link to a response that is defined in the OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character X. For example, 2XX represents all response codes between \[200-299\]. Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.
@@ -103,7 +103,7 @@ ___
**● 4XX**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1295](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1295)*
+*Defined in [openapi/interfaces.ts:1295](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1295)*
Any HTTP status code can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A Reference Object can link to a response that is defined in the OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character X. For example, 2XX represents all response codes between \[200-299\]. Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.
@@ -120,7 +120,7 @@ ___
**● 5XX**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1312](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1312)*
+*Defined in [openapi/interfaces.ts:1312](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1312)*
Any HTTP status code can be used as the property name, but only one property per code, to describe the expected response for that HTTP status code. A Reference Object can link to a response that is defined in the OpenAPI Object's components/responses section. This field MUST be enclosed in quotation marks (for example, "200") for compatibility between JSON and YAML. To define a range of response codes, this field MAY contain the uppercase wildcard character X. For example, 2XX represents all response codes between \[200-299\]. Only the following range definitions are allowed: 1XX, 2XX, 3XX, 4XX, and 5XX. If a response is defined using an explicit code, the explicit code definition takes precedence over the range definition for that code.
@@ -137,7 +137,7 @@ ___
**● default**: *[IApiResponse](_openapi_interfaces_.iapiresponse.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1210](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1210)*
+*Defined in [openapi/interfaces.ts:1210](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1210)*
The documentation of responses other than the ones declared for specific HTTP response codes. Use this field to cover undeclared responses. A Reference Object can link to a response that the OpenAPI Object's components/responses section defines.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapischema.md b/docs/api/core/interfaces/_openapi_interfaces_.iapischema.md
index d8fa317358..e85c6da50d 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapischema.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapischema.md
@@ -66,7 +66,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● additionalProperties**: *`boolean` \| [IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1658](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1658)*
+*Defined in [openapi/interfaces.ts:1658](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1658)*
___
@@ -75,7 +75,7 @@ ___
**● allOf**: *([IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md))[]*
-*Defined in [openapi/interfaces.ts:1650](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1650)*
+*Defined in [openapi/interfaces.ts:1650](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1650)*
___
@@ -84,7 +84,7 @@ ___
**● anyOf**: *([IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md))[]*
-*Defined in [openapi/interfaces.ts:1652](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1652)*
+*Defined in [openapi/interfaces.ts:1652](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1652)*
___
@@ -93,7 +93,7 @@ ___
**● default**: *`any`*
-*Defined in [openapi/interfaces.ts:1661](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1661)*
+*Defined in [openapi/interfaces.ts:1661](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1661)*
___
@@ -102,7 +102,7 @@ ___
**● deprecated**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1747](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1747)*
+*Defined in [openapi/interfaces.ts:1747](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1747)*
Specifies that a schema is deprecated and SHOULD be transitioned out of usage. Default value is false.
@@ -119,7 +119,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1659](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1659)*
+*Defined in [openapi/interfaces.ts:1659](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1659)*
___
@@ -128,7 +128,7 @@ ___
**● discriminator**: *[IApiDiscriminator](_openapi_interfaces_.iapidiscriminator.md)*
-*Defined in [openapi/interfaces.ts:1681](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1681)*
+*Defined in [openapi/interfaces.ts:1681](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1681)*
Adds support for polymorphism. The discriminator is an object name that is used to differentiate between other schemas which may satisfy the payload description. See Composition and Inheritance for more details.
@@ -145,7 +145,7 @@ ___
**● enum**: *`any`[]*
-*Defined in [openapi/interfaces.ts:1648](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1648)*
+*Defined in [openapi/interfaces.ts:1648](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1648)*
___
@@ -154,7 +154,7 @@ ___
**● example**: *`any`*
-*Defined in [openapi/interfaces.ts:1737](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1737)*
+*Defined in [openapi/interfaces.ts:1737](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1737)*
A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary.
@@ -171,7 +171,7 @@ ___
**● exclusiveMaximum**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1636](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1636)*
+*Defined in [openapi/interfaces.ts:1636](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1636)*
___
@@ -180,7 +180,7 @@ ___
**● exclusiveMinimum**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1638](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1638)*
+*Defined in [openapi/interfaces.ts:1638](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1638)*
___
@@ -189,7 +189,7 @@ ___
**● externalDocs**: *[IApiExternalDocumentation](_openapi_interfaces_.iapiexternaldocumentation.md)*
-*Defined in [openapi/interfaces.ts:1726](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1726)*
+*Defined in [openapi/interfaces.ts:1726](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1726)*
Additional external documentation for this schema.
@@ -206,7 +206,7 @@ ___
**● format**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1660](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1660)*
+*Defined in [openapi/interfaces.ts:1660](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1660)*
___
@@ -215,7 +215,7 @@ ___
**● items**: *[IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1654](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1654)*
+*Defined in [openapi/interfaces.ts:1654](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1654)*
___
@@ -224,7 +224,7 @@ ___
**● maxItems**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1642](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1642)*
+*Defined in [openapi/interfaces.ts:1642](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1642)*
___
@@ -233,7 +233,7 @@ ___
**● maxLength**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1639](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1639)*
+*Defined in [openapi/interfaces.ts:1639](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1639)*
___
@@ -242,7 +242,7 @@ ___
**● maxProperties**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1645](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1645)*
+*Defined in [openapi/interfaces.ts:1645](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1645)*
___
@@ -251,7 +251,7 @@ ___
**● maximum**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1635](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1635)*
+*Defined in [openapi/interfaces.ts:1635](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1635)*
___
@@ -260,7 +260,7 @@ ___
**● minItems**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1643](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1643)*
+*Defined in [openapi/interfaces.ts:1643](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1643)*
___
@@ -269,7 +269,7 @@ ___
**● minLength**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1640](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1640)*
+*Defined in [openapi/interfaces.ts:1640](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1640)*
___
@@ -278,7 +278,7 @@ ___
**● minProperties**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1646](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1646)*
+*Defined in [openapi/interfaces.ts:1646](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1646)*
___
@@ -287,7 +287,7 @@ ___
**● minimum**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1637](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1637)*
+*Defined in [openapi/interfaces.ts:1637](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1637)*
___
@@ -296,7 +296,7 @@ ___
**● multipleOf**: *`undefined` \| `number`*
-*Defined in [openapi/interfaces.ts:1634](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1634)*
+*Defined in [openapi/interfaces.ts:1634](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1634)*
___
@@ -305,7 +305,7 @@ ___
**● not**: *[IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md)*
-*Defined in [openapi/interfaces.ts:1653](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1653)*
+*Defined in [openapi/interfaces.ts:1653](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1653)*
___
@@ -314,7 +314,7 @@ ___
**● nullable**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1670](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1670)*
+*Defined in [openapi/interfaces.ts:1670](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1670)*
Allows sending a null value for the defined schema. Default value is false.
@@ -331,7 +331,7 @@ ___
**● oneOf**: *([IApiSchema](_openapi_interfaces_.iapischema.md) \| [IApiReference](_openapi_interfaces_.iapireference.md))[]*
-*Defined in [openapi/interfaces.ts:1651](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1651)*
+*Defined in [openapi/interfaces.ts:1651](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1651)*
___
@@ -340,7 +340,7 @@ ___
**● pattern**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1641](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1641)*
+*Defined in [openapi/interfaces.ts:1641](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1641)*
___
@@ -349,7 +349,7 @@ ___
**● properties**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:1655](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1655)*
+*Defined in [openapi/interfaces.ts:1655](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1655)*
___
@@ -358,7 +358,7 @@ ___
**● readOnly**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1694](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1694)*
+*Defined in [openapi/interfaces.ts:1694](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1694)*
Relevant only for Schema "properties" definitions. Declares the property as "read only". This means that it MAY be sent as part of a response but SHOULD NOT be sent as part of the request. If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.
@@ -375,7 +375,7 @@ ___
**● required**: *`string`[]*
-*Defined in [openapi/interfaces.ts:1647](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1647)*
+*Defined in [openapi/interfaces.ts:1647](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1647)*
___
@@ -384,7 +384,7 @@ ___
**● title**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1633](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1633)*
+*Defined in [openapi/interfaces.ts:1633](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1633)*
___
@@ -393,7 +393,7 @@ ___
**● type**: *"null" \| "boolean" \| "object" \| "array" \| "number" \| "string" \| "integer"*
-*Defined in [openapi/interfaces.ts:1649](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1649)*
+*Defined in [openapi/interfaces.ts:1649](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1649)*
___
@@ -402,7 +402,7 @@ ___
**● uniqueItems**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1644](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1644)*
+*Defined in [openapi/interfaces.ts:1644](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1644)*
___
@@ -411,7 +411,7 @@ ___
**● writeOnly**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1707](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1707)*
+*Defined in [openapi/interfaces.ts:1707](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1707)*
Relevant only for Schema "properties" definitions. Declares the property as "write only". Therefore, it MAY be sent as part of a request but SHOULD NOT be sent as part of the response. If the property is marked as writeOnly being true and is in the required list, the required will take effect on the request only. A property MUST NOT be marked as both readOnly and writeOnly being true. Default value is false.
@@ -428,7 +428,7 @@ ___
**● xml**: *[IApiXML](_openapi_interfaces_.iapixml.md)*
-*Defined in [openapi/interfaces.ts:1717](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1717)*
+*Defined in [openapi/interfaces.ts:1717](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1717)*
This MAY be used only on properties schemas. It has no effect on root schemas. Adds additional metadata to describe the XML representation of this property.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiserver.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiserver.md
index 43a09fcbdc..4b72de6da6 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiserver.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiserver.md
@@ -32,7 +32,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:263](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L263)*
+*Defined in [openapi/interfaces.ts:263](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L263)*
An optional string describing the host designated by the URL. CommonMark syntax MAY be used for rich text representation.
@@ -49,7 +49,7 @@ ___
**● url**: *`string`*
-*Defined in [openapi/interfaces.ts:253](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L253)*
+*Defined in [openapi/interfaces.ts:253](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L253)*
A URL to the target host. This URL supports Server Variables and MAY be relative, to indicate that the host location is relative to the location where the OpenAPI document is being served. Variable substitutions will be made when a variable is named in {brackets}.
@@ -66,7 +66,7 @@ ___
**● variables**: *`undefined` \| `object`*
-*Defined in [openapi/interfaces.ts:275](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L275)*
+*Defined in [openapi/interfaces.ts:275](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L275)*
A map between a variable name and its value. The value is used for substitution in the server's URL template.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapiservervariable.md b/docs/api/core/interfaces/_openapi_interfaces_.iapiservervariable.md
index 1ee3aa1862..6616f41909 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapiservervariable.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapiservervariable.md
@@ -32,7 +32,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● default**: *`string`*
-*Defined in [openapi/interfaces.ts:309](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L309)*
+*Defined in [openapi/interfaces.ts:309](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L309)*
The default value to use for substitution, which SHALL be sent if an alternate value is not supplied. Note this behavior is different than the Schema Object's treatment of default values, because in those cases parameter values are optional.
@@ -49,7 +49,7 @@ ___
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:319](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L319)*
+*Defined in [openapi/interfaces.ts:319](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L319)*
An optional description for the server variable. CommonMark syntax MAY be used for rich text representation.
@@ -66,7 +66,7 @@ ___
**● enum**: *`string`[]*
-*Defined in [openapi/interfaces.ts:298](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L298)*
+*Defined in [openapi/interfaces.ts:298](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L298)*
An enumeration of string values to be used if the substitution options are from a limited set.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapitag.md b/docs/api/core/interfaces/_openapi_interfaces_.iapitag.md
index f97ea0953e..a4eed11aa4 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapitag.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapitag.md
@@ -32,7 +32,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● description**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1580](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1580)*
+*Defined in [openapi/interfaces.ts:1580](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1580)*
A short description for the tag. CommonMark syntax MAY be used for rich text representation.
@@ -49,7 +49,7 @@ ___
**● externalDocs**: *[IApiExternalDocumentation](_openapi_interfaces_.iapiexternaldocumentation.md)*
-*Defined in [openapi/interfaces.ts:1589](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1589)*
+*Defined in [openapi/interfaces.ts:1589](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1589)*
Additional external documentation for this tag.
@@ -66,7 +66,7 @@ ___
**● name**: *`string`*
-*Defined in [openapi/interfaces.ts:1570](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1570)*
+*Defined in [openapi/interfaces.ts:1570](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1570)*
The name of the tag.
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iapixml.md b/docs/api/core/interfaces/_openapi_interfaces_.iapixml.md
index a42b03b8fa..a5aae30952 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iapixml.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iapixml.md
@@ -36,7 +36,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● attribute**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1841](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1841)*
+*Defined in [openapi/interfaces.ts:1841](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1841)*
Declares whether the property definition translates to an attribute instead of an element. Default value is false.
@@ -53,7 +53,7 @@ ___
**● name**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1813](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1813)*
+*Defined in [openapi/interfaces.ts:1813](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1813)*
Replaces the name of the element/attribute used for the described schema property. When defined within items, it will affect the name of the individual XML elements within the list. When defined alongside type being array (outside the items), it will affect the wrapping element and only if wrapped is true. If wrapped is false, it will be ignored.
@@ -70,7 +70,7 @@ ___
**● namespace**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1822](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1822)*
+*Defined in [openapi/interfaces.ts:1822](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1822)*
The URI of the namespace definition. Value MUST be in the form of an absolute URI.
@@ -87,7 +87,7 @@ ___
**● prefix**: *`undefined` \| `string`*
-*Defined in [openapi/interfaces.ts:1831](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1831)*
+*Defined in [openapi/interfaces.ts:1831](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1831)*
The prefix to be used for the name.
@@ -104,7 +104,7 @@ ___
**● wrapped**: *`undefined` \| `false` \| `true`*
-*Defined in [openapi/interfaces.ts:1853](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L1853)*
+*Defined in [openapi/interfaces.ts:1853](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L1853)*
MAY be used only for an array definition. Signifies whether the array is wrapped (for example, ) or unwrapped (). Default value is false. The definition takes effect only when defined alongside type being array (outside the items).
diff --git a/docs/api/core/interfaces/_openapi_interfaces_.iopenapi.md b/docs/api/core/interfaces/_openapi_interfaces_.iopenapi.md
index 893f2083e2..b082fd40f8 100644
--- a/docs/api/core/interfaces/_openapi_interfaces_.iopenapi.md
+++ b/docs/api/core/interfaces/_openapi_interfaces_.iopenapi.md
@@ -37,7 +37,7 @@ Source: [https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2
**● components**: *[IApiComponents](_openapi_interfaces_.iapicomponents.md)*
-*Defined in [openapi/interfaces.ts:59](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L59)*
+*Defined in [openapi/interfaces.ts:59](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L59)*
An element to hold various schemas for the specification.
@@ -54,7 +54,7 @@ ___
**● externalDocs**: *[IApiExternalDocumentation](_openapi_interfaces_.iapiexternaldocumentation.md)*
-*Defined in [openapi/interfaces.ts:93](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L93)*
+*Defined in [openapi/interfaces.ts:93](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L93)*
Additional external documentation.
@@ -71,7 +71,7 @@ ___
**● info**: *[IApiInfo](_openapi_interfaces_.iapiinfo.md)*
-*Defined in [openapi/interfaces.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L30)*
+*Defined in [openapi/interfaces.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L30)*
Provides metadata about the API. The metadata MAY be used by tooling as required.
@@ -88,7 +88,7 @@ ___
**● openapi**: *`string`*
-*Defined in [openapi/interfaces.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L21)*
+*Defined in [openapi/interfaces.ts:21](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L21)*
This string MUST be the semantic version number of the OpenAPI Specification version that the OpenAPI document uses. The openapi field SHOULD be used by tooling specifications and clients to interpret the OpenAPI document. This is not related to the API info.version string.
@@ -105,7 +105,7 @@ ___
**● paths**: *[IApiPaths](_openapi_interfaces_.iapipaths.md)*
-*Defined in [openapi/interfaces.ts:50](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L50)*
+*Defined in [openapi/interfaces.ts:50](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L50)*
The available paths and operations for the API.
@@ -122,7 +122,7 @@ ___
**● security**: *[IApiSecurityRequirement](_openapi_interfaces_.iapisecurityrequirement.md)[]*
-*Defined in [openapi/interfaces.ts:71](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L71)*
+*Defined in [openapi/interfaces.ts:71](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L71)*
A declaration of which security mechanisms can be used across the API. The list of values includes alternative security requirement objects that can be used. Only one of the security requirement objects need to be satisfied to authorize a request. Individual operations can override this definition.
@@ -139,7 +139,7 @@ ___
**● servers**: *[IApiServer](_openapi_interfaces_.iapiserver.md)[]*
-*Defined in [openapi/interfaces.ts:41](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L41)*
+*Defined in [openapi/interfaces.ts:41](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L41)*
An array of Server Objects, which provide connectivity information to a target server. If the servers property is not provided, or is an empty array, the default value would be a Server Object with a url value of /.
@@ -156,7 +156,7 @@ ___
**● tags**: *[IApiTag](_openapi_interfaces_.iapitag.md)[]*
-*Defined in [openapi/interfaces.ts:84](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/openapi/interfaces.ts#L84)*
+*Defined in [openapi/interfaces.ts:84](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/openapi/interfaces.ts#L84)*
A list of tags used by the specification with additional metadata. The order of the tags can be used to reflect on their order by the parsing tools. Not all tags that are used by the Operation Object must be declared. The tags that are not declared MAY be organized randomly or based on the tools' logic. Each tag name in the list MUST be unique.
diff --git a/docs/api/core/interfaces/_sessions_session_store_.sessionoptions.md b/docs/api/core/interfaces/_sessions_session_store_.sessionoptions.md
index e759a3ec6a..3fddc31241 100644
--- a/docs/api/core/interfaces/_sessions_session_store_.sessionoptions.md
+++ b/docs/api/core/interfaces/_sessions_session_store_.sessionoptions.md
@@ -22,7 +22,7 @@
**● csrfToken**: *`undefined` \| `false` \| `true`*
-*Defined in [sessions/session-store.ts:8](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/session-store.ts#L8)*
+*Defined in [sessions/session-store.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/session-store.ts#L8)*
___
diff --git a/docs/api/core/interfaces/_sessions_token_hook_.tokenoptions.md b/docs/api/core/interfaces/_sessions_token_hook_.tokenoptions.md
index 9f729d8d59..5856095f46 100644
--- a/docs/api/core/interfaces/_sessions_token_hook_.tokenoptions.md
+++ b/docs/api/core/interfaces/_sessions_token_hook_.tokenoptions.md
@@ -27,7 +27,7 @@
**● cookie**: *`undefined` \| `false` \| `true`*
-*Defined in [sessions/token.hook.ts:37](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L37)*
+*Defined in [sessions/token.hook.ts:39](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L39)*
___
@@ -36,7 +36,7 @@ ___
**● extendLifeTimeOrUpdate**: *`undefined` \| `false` \| `true`*
-*Defined in [sessions/token.hook.ts:40](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L40)*
+*Defined in [sessions/token.hook.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L42)*
___
@@ -45,7 +45,7 @@ ___
**● openapi**: *`undefined` \| `false` \| `true`*
-*Defined in [sessions/token.hook.ts:39](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L39)*
+*Defined in [sessions/token.hook.ts:41](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L41)*
___
@@ -54,7 +54,7 @@ ___
**● redirectTo**: *`undefined` \| `string`*
-*Defined in [sessions/token.hook.ts:38](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L38)*
+*Defined in [sessions/token.hook.ts:40](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L40)*
___
@@ -63,7 +63,7 @@ ___
**● store**: *[Class](../modules/_core_class_interface_.md#class)<[SessionStore](../classes/_sessions_session_store_.sessionstore.md)>*
-*Defined in [sessions/token.hook.ts:36](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L36)*
+*Defined in [sessions/token.hook.ts:38](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L38)*
___
@@ -72,7 +72,7 @@ ___
**● user**: *`undefined` \| `function`*
-*Defined in [sessions/token.hook.ts:35](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/sessions/token.hook.ts#L35)*
+*Defined in [sessions/token.hook.ts:37](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/sessions/token.hook.ts#L37)*
___
diff --git a/docs/api/core/modules/_common_errors_object_does_not_exist_.md b/docs/api/core/modules/_common_errors_object_does_not_exist_.md
index f535f24294..227cbef3bb 100644
--- a/docs/api/core/modules/_common_errors_object_does_not_exist_.md
+++ b/docs/api/core/modules/_common_errors_object_does_not_exist_.md
@@ -22,7 +22,7 @@
▸ **isObjectDoesNotExist**(err: *`object`*): `boolean`
-*Defined in [common/errors/object-does-not-exist.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L30)*
+*Defined in [common/errors/object-does-not-exist.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/object-does-not-exist.ts#L30)*
Check if an error is an instance of ObjectDoesNotExist.
diff --git a/docs/api/core/modules/_common_errors_permission_denied_.md b/docs/api/core/modules/_common_errors_permission_denied_.md
index bf72a5de56..bfa664d155 100644
--- a/docs/api/core/modules/_common_errors_permission_denied_.md
+++ b/docs/api/core/modules/_common_errors_permission_denied_.md
@@ -22,7 +22,7 @@
▸ **isPermissionDenied**(err: *`object`*): `boolean`
-*Defined in [common/errors/permission-denied.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L30)*
+*Defined in [common/errors/permission-denied.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/permission-denied.ts#L30)*
Check if an error is an instance of PermissionDenied.
diff --git a/docs/api/core/modules/_common_errors_validation_error_.md b/docs/api/core/modules/_common_errors_validation_error_.md
index 453068615f..22d2420b68 100644
--- a/docs/api/core/modules/_common_errors_validation_error_.md
+++ b/docs/api/core/modules/_common_errors_validation_error_.md
@@ -22,7 +22,7 @@
▸ **isValidationError**(err: *`object`*): `boolean`
-*Defined in [common/errors/validation-error.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L30)*
+*Defined in [common/errors/validation-error.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/errors/validation-error.ts#L30)*
Check if an error is an instance of ValidationError.
diff --git a/docs/api/core/modules/_common_hooks_extract_properties_util_.md b/docs/api/core/modules/_common_hooks_extract_properties_util_.md
index 62548f028e..10b68a7d9f 100644
--- a/docs/api/core/modules/_common_hooks_extract_properties_util_.md
+++ b/docs/api/core/modules/_common_hooks_extract_properties_util_.md
@@ -18,7 +18,7 @@
▸ **extractProperties**(schema: *`object`*): `object`[]
-*Defined in [common/hooks/extract-properties.util.ts:8](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/extract-properties.util.ts#L8)*
+*Defined in [common/hooks/extract-properties.util.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/extract-properties.util.ts#L8)*
Returns the properties of an AJV schema of type object.
diff --git a/docs/api/core/modules/_common_hooks_is_function_util_.md b/docs/api/core/modules/_common_hooks_is_function_util_.md
index 6e818224b9..3a13fc00e4 100644
--- a/docs/api/core/modules/_common_hooks_is_function_util_.md
+++ b/docs/api/core/modules/_common_hooks_is_function_util_.md
@@ -18,7 +18,7 @@
▸ **isFunction**(schema: *`object` \| `function`*): `boolean`
-*Defined in [common/hooks/is-function.util.ts:1](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/is-function.util.ts#L1)*
+*Defined in [common/hooks/is-function.util.ts:1](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/is-function.util.ts#L1)*
**Parameters:**
diff --git a/docs/api/core/modules/_common_hooks_log_hook_.md b/docs/api/core/modules/_common_hooks_log_hook_.md
index 8b97dcd818..049af435b3 100644
--- a/docs/api/core/modules/_common_hooks_log_hook_.md
+++ b/docs/api/core/modules/_common_hooks_log_hook_.md
@@ -22,7 +22,7 @@
▸ **Log**(message: *`string`*, options?: *[LogOptions](../interfaces/_common_hooks_log_hook_.logoptions.md)*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/log.hook.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/log.hook.ts#L32)*
+*Defined in [common/hooks/log.hook.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/log.hook.ts#L32)*
Hook factory logging a message with optional information on the HTTP request.
diff --git a/docs/api/core/modules/_common_hooks_validate_body_hook_.md b/docs/api/core/modules/_common_hooks_validate_body_hook_.md
index a28828a554..c6ef607bcc 100644
--- a/docs/api/core/modules/_common_hooks_validate_body_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_body_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateBody**(schema: *`object` \| `function`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-body.hook.ts:15](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-body.hook.ts#L15)*
+*Defined in [common/hooks/validate-body.hook.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-body.hook.ts#L15)*
Hook factory validating the body of the request against a AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_cookie_hook_.md b/docs/api/core/modules/_common_hooks_validate_cookie_hook_.md
index 74f0e2593c..763fa523c7 100644
--- a/docs/api/core/modules/_common_hooks_validate_cookie_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_cookie_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateCookie**(name: *`string`*, schema?: *`object` \| `function`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-cookie.hook.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-cookie.hook.ts#L19)*
+*Defined in [common/hooks/validate-cookie.hook.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-cookie.hook.ts#L19)*
Hook - Validate a specific cookie against an AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_cookies_hook_.md b/docs/api/core/modules/_common_hooks_validate_cookies_hook_.md
index b1ae9c39ba..0356c39a1d 100644
--- a/docs/api/core/modules/_common_hooks_validate_cookies_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_cookies_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateCookies**(schema: *`object`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-cookies.hook.ts:15](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-cookies.hook.ts#L15)*
+*Defined in [common/hooks/validate-cookies.hook.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-cookies.hook.ts#L15)*
Hook factory validating the cookies of the request against a AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_header_hook_.md b/docs/api/core/modules/_common_hooks_validate_header_hook_.md
index 364ffce6e8..217944152d 100644
--- a/docs/api/core/modules/_common_hooks_validate_header_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_header_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateHeader**(name: *`string`*, schema?: *`object` \| `function`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-header.hook.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-header.hook.ts#L19)*
+*Defined in [common/hooks/validate-header.hook.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-header.hook.ts#L19)*
Hook - Validate a specific header against an AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_headers_hook_.md b/docs/api/core/modules/_common_hooks_validate_headers_hook_.md
index 3da0a856f8..e96af68e80 100644
--- a/docs/api/core/modules/_common_hooks_validate_headers_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_headers_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateHeaders**(schema: *`object`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-headers.hook.ts:15](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-headers.hook.ts#L15)*
+*Defined in [common/hooks/validate-headers.hook.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-headers.hook.ts#L15)*
Hook factory validating the headers of the request against a AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_params_hook_.md b/docs/api/core/modules/_common_hooks_validate_params_hook_.md
index c19d7f57b4..a92d81cec7 100644
--- a/docs/api/core/modules/_common_hooks_validate_params_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_params_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateParams**(schema: *`object`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-params.hook.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-params.hook.ts#L14)*
+*Defined in [common/hooks/validate-params.hook.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-params.hook.ts#L14)*
Hook factory validating the params of the request against a AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_path_param_hook_.md b/docs/api/core/modules/_common_hooks_validate_path_param_hook_.md
index fa5afa50cf..25f9d5bac5 100644
--- a/docs/api/core/modules/_common_hooks_validate_path_param_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_path_param_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidatePathParam**(name: *`string`*, schema: *`object` \| `function`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-path-param.hook.ts:18](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-path-param.hook.ts#L18)*
+*Defined in [common/hooks/validate-path-param.hook.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-path-param.hook.ts#L18)*
Hook - Validate a specific path parameter against an AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_query_hook_.md b/docs/api/core/modules/_common_hooks_validate_query_hook_.md
index b505d56143..21751cf802 100644
--- a/docs/api/core/modules/_common_hooks_validate_query_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_query_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateQuery**(schema: *`object`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-query.hook.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-query.hook.ts#L14)*
+*Defined in [common/hooks/validate-query.hook.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-query.hook.ts#L14)*
Hook factory validating the query of the request against a AJV schema.
diff --git a/docs/api/core/modules/_common_hooks_validate_query_param_hook_.md b/docs/api/core/modules/_common_hooks_validate_query_param_hook_.md
index 1fa78a928c..f5a99ad5d1 100644
--- a/docs/api/core/modules/_common_hooks_validate_query_param_hook_.md
+++ b/docs/api/core/modules/_common_hooks_validate_query_param_hook_.md
@@ -18,7 +18,7 @@
▸ **ValidateQueryParam**(name: *`string`*, schema?: *`object` \| `function`*, options?: *`object`*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [common/hooks/validate-query-param.hook.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/hooks/validate-query-param.hook.ts#L19)*
+*Defined in [common/hooks/validate-query-param.hook.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/hooks/validate-query-param.hook.ts#L19)*
Hook - Validate a specific query parameter against an AJV schema.
diff --git a/docs/api/core/modules/_common_tokens_convert_base64_to_base64_url_util_.md b/docs/api/core/modules/_common_tokens_convert_base64_to_base64_url_util_.md
index b43deaa956..30e9500dda 100644
--- a/docs/api/core/modules/_common_tokens_convert_base64_to_base64_url_util_.md
+++ b/docs/api/core/modules/_common_tokens_convert_base64_to_base64_url_util_.md
@@ -18,7 +18,7 @@
▸ **convertBase64ToBase64url**(str: *`string`*): `string`
-*Defined in [common/tokens/convert-base64-to-base64-url.util.ts:8](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/convert-base64-to-base64-url.util.ts#L8)*
+*Defined in [common/tokens/convert-base64-to-base64-url.util.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/convert-base64-to-base64-url.util.ts#L8)*
Convert a base64-encode string into a base64url-encode string with no equals.
diff --git a/docs/api/core/modules/_common_tokens_generate_signed_token_util_.md b/docs/api/core/modules/_common_tokens_generate_signed_token_util_.md
index d956273346..ffb370c492 100644
--- a/docs/api/core/modules/_common_tokens_generate_signed_token_util_.md
+++ b/docs/api/core/modules/_common_tokens_generate_signed_token_util_.md
@@ -18,7 +18,7 @@
▸ **generateSignedToken**(secret: *`string`*): `Promise`<`string`>
-*Defined in [common/tokens/generate-signed-token.util.ts:4](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/generate-signed-token.util.ts#L4)*
+*Defined in [common/tokens/generate-signed-token.util.ts:4](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/generate-signed-token.util.ts#L4)*
**Parameters:**
diff --git a/docs/api/core/modules/_common_tokens_generate_token_util_.md b/docs/api/core/modules/_common_tokens_generate_token_util_.md
index 6937856bfc..3e7fa28f51 100644
--- a/docs/api/core/modules/_common_tokens_generate_token_util_.md
+++ b/docs/api/core/modules/_common_tokens_generate_token_util_.md
@@ -18,7 +18,7 @@
▸ **generateToken**(): `Promise`<`string`>
-*Defined in [common/tokens/generate-token.util.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/generate-token.util.ts#L14)*
+*Defined in [common/tokens/generate-token.util.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/generate-token.util.ts#L14)*
Generate a 128-bit base64url-encoded token.
diff --git a/docs/api/core/modules/_common_tokens_sign_token_util_.md b/docs/api/core/modules/_common_tokens_sign_token_util_.md
index 0514b5c3d4..7b7a537835 100644
--- a/docs/api/core/modules/_common_tokens_sign_token_util_.md
+++ b/docs/api/core/modules/_common_tokens_sign_token_util_.md
@@ -19,7 +19,7 @@
▸ **sign**(base64Value: *`string`*, base64Secret: *`string`*): `Buffer`
-*Defined in [common/tokens/sign-token.util.ts:7](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/sign-token.util.ts#L7)*
+*Defined in [common/tokens/sign-token.util.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/sign-token.util.ts#L7)*
**Parameters:**
@@ -37,7 +37,7 @@ ___
▸ **signToken**(unsignedToken: *`string`*, secret: *`string`*): `string`
-*Defined in [common/tokens/sign-token.util.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/sign-token.util.ts#L13)*
+*Defined in [common/tokens/sign-token.util.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/sign-token.util.ts#L13)*
**Parameters:**
diff --git a/docs/api/core/modules/_common_tokens_verify_signed_token_util_.md b/docs/api/core/modules/_common_tokens_verify_signed_token_util_.md
index a06edda9d5..3c49e47ba0 100644
--- a/docs/api/core/modules/_common_tokens_verify_signed_token_util_.md
+++ b/docs/api/core/modules/_common_tokens_verify_signed_token_util_.md
@@ -18,7 +18,7 @@
▸ **verifySignedToken**(signedToken: *`string`*, secret: *`string`*): `string` \| `false`
-*Defined in [common/tokens/verify-signed-token.util.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/tokens/verify-signed-token.util.ts#L19)*
+*Defined in [common/tokens/verify-signed-token.util.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/tokens/verify-signed-token.util.ts#L19)*
Verify a base64-encoded (or base64url-encoded) signed token against a secret.
diff --git a/docs/api/core/modules/_common_utils_controller_util_.md b/docs/api/core/modules/_common_utils_controller_util_.md
index 5a2a2b436f..6e3fa0d0df 100644
--- a/docs/api/core/modules/_common_utils_controller_util_.md
+++ b/docs/api/core/modules/_common_utils_controller_util_.md
@@ -18,7 +18,7 @@
▸ **controller**(path: *`string`*, controllerClass: *[Class](_core_class_interface_.md#class)*): [Class](_core_class_interface_.md#class)
-*Defined in [common/utils/controller.util.ts:16](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/controller.util.ts#L16)*
+*Defined in [common/utils/controller.util.ts:16](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/controller.util.ts#L16)*
Define the HTTP path of a controller class. This function is usually called when adding the controller as a sub-controller.
diff --git a/docs/api/core/modules/_common_utils_escape_.md b/docs/api/core/modules/_common_utils_escape_.md
index 091145d5f2..d770154e58 100644
--- a/docs/api/core/modules/_common_utils_escape_.md
+++ b/docs/api/core/modules/_common_utils_escape_.md
@@ -22,7 +22,7 @@
▸ **escape**(str: *`string`*): `string`
-*Defined in [common/utils/escape.ts:20](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L20)*
+*Defined in [common/utils/escape.ts:20](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L20)*
Escape a string following OWASP recommandations to prevent XSS attacks.
@@ -49,7 +49,7 @@ ___
**escapeMap**: *`object`*
-*Defined in [common/utils/escape.ts:1](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L1)*
+*Defined in [common/utils/escape.ts:1](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L1)*
@@ -57,7 +57,7 @@ ___
**● "**: *`string`* = """
-*Defined in [common/utils/escape.ts:2](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L2)*
+*Defined in [common/utils/escape.ts:2](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L2)*
___
@@ -66,7 +66,7 @@ ___
**● &**: *`string`* = "&"
-*Defined in [common/utils/escape.ts:3](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L3)*
+*Defined in [common/utils/escape.ts:3](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L3)*
___
@@ -75,7 +75,7 @@ ___
**● '**: *`string`* = "'"
-*Defined in [common/utils/escape.ts:4](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L4)*
+*Defined in [common/utils/escape.ts:4](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L4)*
___
@@ -84,7 +84,7 @@ ___
**● /**: *`string`* = "/"
-*Defined in [common/utils/escape.ts:5](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L5)*
+*Defined in [common/utils/escape.ts:5](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L5)*
___
@@ -93,7 +93,7 @@ ___
**● <**: *`string`* = "<"
-*Defined in [common/utils/escape.ts:6](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L6)*
+*Defined in [common/utils/escape.ts:6](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L6)*
___
@@ -102,7 +102,7 @@ ___
**● >**: *`string`* = ">"
-*Defined in [common/utils/escape.ts:7](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape.ts#L7)*
+*Defined in [common/utils/escape.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape.ts#L7)*
___
diff --git a/docs/api/core/modules/_common_utils_escape_prop_.md b/docs/api/core/modules/_common_utils_escape_prop_.md
index f132740e61..c7eb2bb1e5 100644
--- a/docs/api/core/modules/_common_utils_escape_prop_.md
+++ b/docs/api/core/modules/_common_utils_escape_prop_.md
@@ -18,7 +18,7 @@
▸ **escapeProp**(object: *`object`*, propName: *`string`*): `void`
-*Defined in [common/utils/escape-prop.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/escape-prop.ts#L13)*
+*Defined in [common/utils/escape-prop.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/escape-prop.ts#L13)*
Escape a string property of an object following OWASP recommandations to prevent XSS attacks.
diff --git a/docs/api/core/modules/_common_utils_get_ajv_instance_.md b/docs/api/core/modules/_common_utils_get_ajv_instance_.md
index 366f4f073a..daa74f9af5 100644
--- a/docs/api/core/modules/_common_utils_get_ajv_instance_.md
+++ b/docs/api/core/modules/_common_utils_get_ajv_instance_.md
@@ -22,7 +22,7 @@
▸ **getAjvInstance**(): `Ajv.Ajv`
-*Defined in [common/utils/get-ajv-instance.ts:26](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/get-ajv-instance.ts#L26)*
+*Defined in [common/utils/get-ajv-instance.ts:26](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/get-ajv-instance.ts#L26)*
Return the Ajv instance used internally by FoalTS.
@@ -49,7 +49,7 @@ ___
**_instanceWrapper**: *`object`*
-*Defined in [common/utils/get-ajv-instance.ts:7](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/get-ajv-instance.ts#L7)*
+*Defined in [common/utils/get-ajv-instance.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/get-ajv-instance.ts#L7)*
@@ -57,7 +57,7 @@ ___
**● instance**: *`null`* = null
-*Defined in [common/utils/get-ajv-instance.ts:8](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/get-ajv-instance.ts#L8)*
+*Defined in [common/utils/get-ajv-instance.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/get-ajv-instance.ts#L8)*
___
diff --git a/docs/api/core/modules/_common_utils_hash_password_util_.md b/docs/api/core/modules/_common_utils_hash_password_util_.md
index dd6876452f..b687cf5f4f 100644
--- a/docs/api/core/modules/_common_utils_hash_password_util_.md
+++ b/docs/api/core/modules/_common_utils_hash_password_util_.md
@@ -19,7 +19,7 @@
▸ **hashPassword**(plainTextPassword: *`string`*, options?: *`object`*): `Promise`<`string`>
-*Defined in [common/utils/hash-password.util.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/hash-password.util.ts#L32)*
+*Defined in [common/utils/hash-password.util.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/hash-password.util.ts#L32)*
Hash a password using the PBKDF2 algorithm.
@@ -51,7 +51,7 @@ ___
▸ **parsePassword**(password: *`string`*): `Promise`<`string`>
-*Defined in [common/utils/hash-password.util.ts:8](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/hash-password.util.ts#L8)*
+*Defined in [common/utils/hash-password.util.ts:8](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/hash-password.util.ts#L8)*
Legacy function to hash passwords. Only kept for backward compatibility.
diff --git a/docs/api/core/modules/_common_utils_is_in_file_util_.md b/docs/api/core/modules/_common_utils_is_in_file_util_.md
index 406434828e..cdcbecd49d 100644
--- a/docs/api/core/modules/_common_utils_is_in_file_util_.md
+++ b/docs/api/core/modules/_common_utils_is_in_file_util_.md
@@ -18,7 +18,7 @@
▸ **isInFile**(path: *`string`*): `function`
-*Defined in [common/utils/is-in-file.util.ts:12](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/is-in-file.util.ts#L12)*
+*Defined in [common/utils/is-in-file.util.ts:12](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/is-in-file.util.ts#L12)*
Generate a function checking if a string is included in a text file.
diff --git a/docs/api/core/modules/_common_utils_render_util_.md b/docs/api/core/modules/_common_utils_render_util_.md
index 788830f2d3..482c727282 100644
--- a/docs/api/core/modules/_common_utils_render_util_.md
+++ b/docs/api/core/modules/_common_utils_render_util_.md
@@ -19,7 +19,7 @@
▸ **render**(templatePath: *`string`*, locals?: *`object`*, dirname?: *`undefined` \| `string`*): `Promise`<[HttpResponseOK](../classes/_core_http_http_responses_.httpresponseok.md)>
-*Defined in [common/utils/render.util.ts:40](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/render.util.ts#L40)*
+*Defined in [common/utils/render.util.ts:40](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/render.util.ts#L40)*
Render a template in a new HttpResponseOK object.
@@ -44,7 +44,7 @@ ___
▸ **renderToString**(template: *`string`*, locals: *`object`*): `string`
-*Defined in [common/utils/render.util.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/render.util.ts#L19)*
+*Defined in [common/utils/render.util.ts:19](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/render.util.ts#L19)*
Util function to render a template. Minimalist built-in template engine for FoalTS.
diff --git a/docs/api/core/modules/_common_utils_validate_util_.md b/docs/api/core/modules/_common_utils_validate_util_.md
index b16bebccdc..e1268b58d8 100644
--- a/docs/api/core/modules/_common_utils_validate_util_.md
+++ b/docs/api/core/modules/_common_utils_validate_util_.md
@@ -18,7 +18,7 @@
▸ **validate**(schema: *`object`*, data: *`any`*): `void`
-*Defined in [common/utils/validate.util.ts:13](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/validate.util.ts#L13)*
+*Defined in [common/utils/validate.util.ts:13](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/validate.util.ts#L13)*
Validate an object against an AJV schema. If the object is not validated, the function throws a ValidationError with the failure details.
diff --git a/docs/api/core/modules/_common_utils_verify_password_util_.md b/docs/api/core/modules/_common_utils_verify_password_util_.md
index 8ab2fc5373..30d29c4a4e 100644
--- a/docs/api/core/modules/_common_utils_verify_password_util_.md
+++ b/docs/api/core/modules/_common_utils_verify_password_util_.md
@@ -18,7 +18,7 @@
▸ **verifyPassword**(plainTextPassword: *`string`*, passwordHash: *`string`*, options?: *`object`*): `Promise`<`boolean`>
-*Defined in [common/utils/verify-password.util.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/utils/verify-password.util.ts#L14)*
+*Defined in [common/utils/verify-password.util.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/common/utils/verify-password.util.ts#L14)*
Compare a plain text password and a hash to see if they match.
diff --git a/docs/api/core/modules/_core_class_interface_.md b/docs/api/core/modules/_core_class_interface_.md
index 9f57a66ec4..eb75c36ca0 100644
--- a/docs/api/core/modules/_core_class_interface_.md
+++ b/docs/api/core/modules/_core_class_interface_.md
@@ -18,7 +18,7 @@
**Ƭ Class**: *`object`*
-*Defined in [core/class.interface.ts:6](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/class.interface.ts#L6)*
+*Defined in [core/class.interface.ts:6](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/class.interface.ts#L6)*
Interface of a class from its class definition.
diff --git a/docs/api/core/modules/_core_controllers_.md b/docs/api/core/modules/_core_controllers_.md
index a55a1ae362..b72b0f882c 100644
--- a/docs/api/core/modules/_core_controllers_.md
+++ b/docs/api/core/modules/_core_controllers_.md
@@ -18,7 +18,7 @@
▸ **createController**<`Controller`>(controllerClass: *[Class](_core_class_interface_.md#class)<`Controller`>*, dependencies?: *`object` \| [ServiceManager](../classes/_core_service_manager_.servicemanager.md)*): `Controller`
-*Defined in [core/controllers.ts:18](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/controllers.ts#L18)*
+*Defined in [core/controllers.ts:18](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/controllers.ts#L18)*
Create a new controller with its dependencies.
diff --git a/docs/api/core/modules/_core_hooks_.md b/docs/api/core/modules/_core_hooks_.md
index 4e5f2f8eaa..a9a81c1974 100644
--- a/docs/api/core/modules/_core_hooks_.md
+++ b/docs/api/core/modules/_core_hooks_.md
@@ -27,7 +27,7 @@
**Ƭ HookDecorator**: *`function`*
-*Defined in [core/hooks.ts:29](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L29)*
+*Defined in [core/hooks.ts:29](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L29)*
Interface of a hook. It is actually the interface of a decorator.
@@ -52,7 +52,7 @@ ___
**Ƭ HookFunction**: *`function`*
-*Defined in [core/hooks.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L21)*
+*Defined in [core/hooks.ts:21](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L21)*
Interface of a function from which a hook can be created.
@@ -77,7 +77,7 @@ ___
**Ƭ HookPostFunction**: *`function`*
-*Defined in [core/hooks.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L14)*
+*Defined in [core/hooks.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L14)*
Interface of a function that can be returned in a hook function. This function is then executed after the controller method execution.
@@ -104,7 +104,7 @@ ___
▸ **Hook**(...hookFunctions: *[HookFunction](_core_hooks_.md#hookfunction)[]*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [core/hooks.ts:38](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L38)*
+*Defined in [core/hooks.ts:38](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L38)*
Create a hook from one or several functions.
@@ -126,7 +126,7 @@ ___
▸ **MergeHooks**(...hookDecorators: *[HookDecorator](_core_hooks_.md#hookdecorator)[]*): [HookDecorator](_core_hooks_.md#hookdecorator)
-*Defined in [core/hooks.ts:82](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L82)*
+*Defined in [core/hooks.ts:82](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L82)*
Group multiple hooks into a new one.
@@ -148,7 +148,7 @@ ___
▸ **getHookFunction**(hook: *[HookDecorator](_core_hooks_.md#hookdecorator)*): [HookFunction](_core_hooks_.md#hookfunction)
-*Defined in [core/hooks.ts:54](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L54)*
+*Defined in [core/hooks.ts:54](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L54)*
Get the function from which the hook was made.
@@ -170,7 +170,7 @@ ___
▸ **getHookFunctions**(hook: *[HookDecorator](_core_hooks_.md#hookdecorator)*): [HookFunction](_core_hooks_.md#hookfunction)[]
-*Defined in [core/hooks.ts:68](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/hooks.ts#L68)*
+*Defined in [core/hooks.ts:68](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/hooks.ts#L68)*
Get the functions from which the hook was made.
diff --git a/docs/api/core/modules/_core_http_http_methods_.md b/docs/api/core/modules/_core_http_http_methods_.md
index efb794364c..a3591688be 100644
--- a/docs/api/core/modules/_core_http_http_methods_.md
+++ b/docs/api/core/modules/_core_http_http_methods_.md
@@ -28,7 +28,7 @@
**Ƭ HttpMethod**: *"POST" \| "GET" \| "PUT" \| "PATCH" \| "DELETE" \| "HEAD" \| "OPTIONS"*
-*Defined in [core/http/http-methods.ts:7](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L7)*
+*Defined in [core/http/http-methods.ts:7](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L7)*
HTTP methods available.
@@ -42,7 +42,7 @@ ___
▸ **Delete**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:100](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L100)*
+*Defined in [core/http/http-methods.ts:100](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L100)*
Decorator specifying that a controller method handles DELETE requests.
@@ -64,7 +64,7 @@ ___
▸ **Get**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:44](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L44)*
+*Defined in [core/http/http-methods.ts:44](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L44)*
Decorator specifying that a controller method handles GET requests.
@@ -86,7 +86,7 @@ ___
▸ **Head**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:16](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L16)*
+*Defined in [core/http/http-methods.ts:16](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L16)*
Decorator specifying that a controller method handles HEAD requests.
@@ -108,7 +108,7 @@ ___
▸ **Options**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L30)*
+*Defined in [core/http/http-methods.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L30)*
Decorator specifying that a controller method handles OPTIONS requests.
@@ -130,7 +130,7 @@ ___
▸ **Patch**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:86](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L86)*
+*Defined in [core/http/http-methods.ts:86](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L86)*
Decorator specifying that a controller method handles PATCH requests.
@@ -152,7 +152,7 @@ ___
▸ **Post**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:58](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L58)*
+*Defined in [core/http/http-methods.ts:58](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L58)*
Decorator specifying that a controller method handles POST requests.
@@ -174,7 +174,7 @@ ___
▸ **Put**(path?: *`undefined` \| `string`*): `(Anonymous function)`
-*Defined in [core/http/http-methods.ts:72](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-methods.ts#L72)*
+*Defined in [core/http/http-methods.ts:72](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-methods.ts#L72)*
Decorator specifying that a controller method handles PUT requests.
diff --git a/docs/api/core/modules/_core_http_http_responses_.md b/docs/api/core/modules/_core_http_http_responses_.md
index fbcae7b11f..974d87a4d2 100644
--- a/docs/api/core/modules/_core_http_http_responses_.md
+++ b/docs/api/core/modules/_core_http_http_responses_.md
@@ -61,7 +61,7 @@
▸ **createHttpResponseFile**(options: *`object`*): `Promise`<[HttpResponseOK](../classes/_core_http_http_responses_.httpresponseok.md)>
-*Defined in [core/http/http-responses.ts:287](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L287)*
+*Defined in [core/http/http-responses.ts:287](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L287)*
Create an HttpResponseOK whose content is the specified file. If returned in a controller, the server sends the file in streaming.
@@ -87,7 +87,7 @@ ___
▸ **isHttpResponse**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:177](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L177)*
+*Defined in [core/http/http-responses.ts:177](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L177)*
Check if an object is an instance of HttpResponse.
@@ -111,7 +111,7 @@ ___
▸ **isHttpResponseBadRequest**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:635](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L635)*
+*Defined in [core/http/http-responses.ts:635](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L635)*
Check if an object is an instance of HttpResponseBadRequest.
@@ -135,7 +135,7 @@ ___
▸ **isHttpResponseClientError**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:589](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L589)*
+*Defined in [core/http/http-responses.ts:589](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L589)*
Check if an object is an instance of HttpResponseClientError.
@@ -159,7 +159,7 @@ ___
▸ **isHttpResponseConflict**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:863](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L863)*
+*Defined in [core/http/http-responses.ts:863](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L863)*
Check if an object is an instance of HttpResponseConflict.
@@ -183,7 +183,7 @@ ___
▸ **isHttpResponseCreated**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:359](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L359)*
+*Defined in [core/http/http-responses.ts:359](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L359)*
Check if an object is an instance of HttpResponseCreated.
@@ -207,7 +207,7 @@ ___
▸ **isHttpResponseForbidden**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:727](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L727)*
+*Defined in [core/http/http-responses.ts:727](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L727)*
Check if an object is an instance of HttpResponseForbidden.
@@ -231,7 +231,7 @@ ___
▸ **isHttpResponseInternalServerError**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:950](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L950)*
+*Defined in [core/http/http-responses.ts:950](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L950)*
Check if an object is an instance of HttpResponseInternalServerError.
@@ -255,7 +255,7 @@ ___
▸ **isHttpResponseMethodNotAllowed**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:818](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L818)*
+*Defined in [core/http/http-responses.ts:818](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L818)*
Check if an object is an instance of HttpResponseMethodNotAllowed.
@@ -279,7 +279,7 @@ ___
▸ **isHttpResponseMovedPermanently**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:496](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L496)*
+*Defined in [core/http/http-responses.ts:496](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L496)*
Check if an object is an instance of HttpResponseMovedPermanently.
@@ -303,7 +303,7 @@ ___
▸ **isHttpResponseNoContent**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:403](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L403)*
+*Defined in [core/http/http-responses.ts:403](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L403)*
Check if an object is an instance of HttpResponseNoContent.
@@ -327,7 +327,7 @@ ___
▸ **isHttpResponseNotFound**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:772](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L772)*
+*Defined in [core/http/http-responses.ts:772](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L772)*
Check if an object is an instance of HttpResponseNotFound.
@@ -351,7 +351,7 @@ ___
▸ **isHttpResponseNotImplemented**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:996](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L996)*
+*Defined in [core/http/http-responses.ts:996](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L996)*
Check if an object is an instance of HttpResponseNotImplemented.
@@ -375,7 +375,7 @@ ___
▸ **isHttpResponseOK**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:268](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L268)*
+*Defined in [core/http/http-responses.ts:268](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L268)*
Check if an object is an instance of HttpResponseOK.
@@ -399,7 +399,7 @@ ___
▸ **isHttpResponseRedirect**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:542](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L542)*
+*Defined in [core/http/http-responses.ts:542](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L542)*
Check if an object is an instance of HttpResponseRedirect.
@@ -423,7 +423,7 @@ ___
▸ **isHttpResponseRedirection**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:450](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L450)*
+*Defined in [core/http/http-responses.ts:450](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L450)*
Check if an object is an instance of HttpResponseRedirection.
@@ -447,7 +447,7 @@ ___
▸ **isHttpResponseServerError**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:904](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L904)*
+*Defined in [core/http/http-responses.ts:904](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L904)*
Check if an object is an instance of HttpResponseServerError.
@@ -471,7 +471,7 @@ ___
▸ **isHttpResponseSuccess**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:223](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L223)*
+*Defined in [core/http/http-responses.ts:223](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L223)*
Check if an object is an instance of HttpResponseSuccess.
@@ -495,7 +495,7 @@ ___
▸ **isHttpResponseUnauthorized**(obj: *`any`*): `boolean`
-*Defined in [core/http/http-responses.ts:682](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/http-responses.ts#L682)*
+*Defined in [core/http/http-responses.ts:682](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/http/http-responses.ts#L682)*
Check if an object is an instance of HttpResponseUnauthorized.
diff --git a/docs/api/core/modules/_core_routes_make_controller_routes_.md b/docs/api/core/modules/_core_routes_make_controller_routes_.md
index 95a7bdc5f0..baf7e523cb 100644
--- a/docs/api/core/modules/_core_routes_make_controller_routes_.md
+++ b/docs/api/core/modules/_core_routes_make_controller_routes_.md
@@ -19,7 +19,7 @@
▸ **getMethods**(obj: *`object` \| `null`*): `string`[]
-*Defined in [core/routes/make-controller-routes.ts:14](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/make-controller-routes.ts#L14)*
+*Defined in [core/routes/make-controller-routes.ts:14](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/make-controller-routes.ts#L14)*
Recursively get the property names of an object and its prototypes.
@@ -39,7 +39,7 @@ ___
▸ **makeControllerRoutes**(parentPath: *`string`*, parentHooks: *[HookFunction](_core_hooks_.md#hookfunction)[]*, controllerClass: *[Class](_core_class_interface_.md#class)*, services: *[ServiceManager](../classes/_core_service_manager_.servicemanager.md)*): [Route](../interfaces/_core_routes_route_interface_.route.md)[]
-*Defined in [core/routes/make-controller-routes.ts:30](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/make-controller-routes.ts#L30)*
+*Defined in [core/routes/make-controller-routes.ts:30](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/make-controller-routes.ts#L30)*
Recursively create the routes of a controller and its subcontrollers from the controller class definition.
diff --git a/docs/api/core/modules/_core_routes_utils_.md b/docs/api/core/modules/_core_routes_utils_.md
index 96700798a2..4202092b7e 100644
--- a/docs/api/core/modules/_core_routes_utils_.md
+++ b/docs/api/core/modules/_core_routes_utils_.md
@@ -21,7 +21,7 @@
▸ **getHttpMethod**(target: *[Class](_core_class_interface_.md#class)*, propertyKey?: *`undefined` \| `string`*): `string` \| `undefined`
-*Defined in [core/routes/utils.ts:31](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/utils.ts#L31)*
+*Defined in [core/routes/utils.ts:31](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/utils.ts#L31)*
Get the HTTP method of a controller method.
@@ -44,7 +44,7 @@ ___
▸ **getMetadata**(metadataKey: *`string`*, target: *[Class](_core_class_interface_.md#class)*, propertyKey?: *`undefined` \| `string`*): `any`
-*Defined in [core/routes/utils.ts:16](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/utils.ts#L16)*
+*Defined in [core/routes/utils.ts:16](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/utils.ts#L16)*
Get metadata of a class or a class method.
@@ -68,7 +68,7 @@ ___
▸ **getPath**(target: *[Class](_core_class_interface_.md#class)*, propertyKey?: *`undefined` \| `string`*): `string` \| `undefined`
-*Defined in [core/routes/utils.ts:43](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/utils.ts#L43)*
+*Defined in [core/routes/utils.ts:43](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/utils.ts#L43)*
Get the path of a controller method.
@@ -91,7 +91,7 @@ ___
▸ **join**(...paths: *(`undefined` \| `string`)[]*): `string`
-*Defined in [core/routes/utils.ts:54](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/routes/utils.ts#L54)*
+*Defined in [core/routes/utils.ts:54](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/routes/utils.ts#L54)*
Join several HTTP request paths together.
diff --git a/docs/api/core/modules/_core_service_manager_.md b/docs/api/core/modules/_core_service_manager_.md
index e5e10904c2..dc250c6616 100644
--- a/docs/api/core/modules/_core_service_manager_.md
+++ b/docs/api/core/modules/_core_service_manager_.md
@@ -28,7 +28,7 @@
▸ **createControllerOrService**<`ControllerOrService`>(controllerOrServiceClass: *[Class](_core_class_interface_.md#class)<`ControllerOrService`>*, dependencies?: *`object` \| [ServiceManager](../classes/_core_service_manager_.servicemanager.md)*): `ControllerOrService`
-*Defined in [core/service-manager.ts:36](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L36)*
+*Defined in [core/service-manager.ts:36](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L36)*
**Type parameters:**
@@ -49,7 +49,7 @@ ___
▸ **createService**<`Service`>(serviceClass: *[Class](_core_class_interface_.md#class)<`Service`>*, dependencies?: *`object` \| [ServiceManager](../classes/_core_service_manager_.servicemanager.md)*): `Service`
-*Defined in [core/service-manager.ts:32](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L32)*
+*Defined in [core/service-manager.ts:32](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L32)*
Create a new service with its dependencies.
@@ -77,7 +77,7 @@ ___
▸ **dependency**(target: *`any`*, propertyKey: *`string`*): `void`
-*Defined in [core/service-manager.ts:15](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/service-manager.ts#L15)*
+*Defined in [core/service-manager.ts:15](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/core/service-manager.ts#L15)*
Decorator injecting a service inside a controller or another service.
diff --git a/docs/api/core/modules/_express_create_app_.md b/docs/api/core/modules/_express_create_app_.md
index 13928f2236..9942d683cd 100644
--- a/docs/api/core/modules/_express_create_app_.md
+++ b/docs/api/core/modules/_express_create_app_.md
@@ -24,7 +24,7 @@
▸ **createAndInitApp**(rootControllerClass: *[Class](_core_class_interface_.md#class)*, expressInstanceOrOptions?: *[ExpressApplication](../interfaces/_express_create_app_.expressapplication.md) \| [ExpressOptions](../interfaces/_express_create_app_.expressoptions.md)*): `Promise`<[ExpressApplication](../interfaces/_express_create_app_.expressapplication.md)>
-*Defined in [express/create-app.ts:156](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-app.ts#L156)*
+*Defined in [express/create-app.ts:155](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-app.ts#L155)*
Create an Express application from the root controller and call its "init" method if it exists.
@@ -47,7 +47,7 @@ ___
▸ **createApp**(rootControllerClass: *[Class](_core_class_interface_.md#class)*, expressInstanceOrOptions?: *[ExpressApplication](../interfaces/_express_create_app_.expressapplication.md) \| [ExpressOptions](../interfaces/_express_create_app_.expressoptions.md)*): [ExpressApplication](../interfaces/_express_create_app_.expressapplication.md)
-*Defined in [express/create-app.ts:43](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-app.ts#L43)*
+*Defined in [express/create-app.ts:42](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-app.ts#L42)*
Create an Express application from the root controller.
diff --git a/docs/api/core/modules/_express_create_middleware_.md b/docs/api/core/modules/_express_create_middleware_.md
index 5529a8af61..5f10903996 100644
--- a/docs/api/core/modules/_express_create_middleware_.md
+++ b/docs/api/core/modules/_express_create_middleware_.md
@@ -18,7 +18,7 @@
▸ **createMiddleware**(route: *[Route](../interfaces/_core_routes_route_interface_.route.md)*, services: *[ServiceManager](../classes/_core_service_manager_.servicemanager.md)*): `function`
-*Defined in [express/create-middleware.ts:20](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/create-middleware.ts#L20)*
+*Defined in [express/create-middleware.ts:20](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/create-middleware.ts#L20)*
Create an express middleware from a Route and the application services.
diff --git a/docs/api/core/modules/_express_handle_errors_.md b/docs/api/core/modules/_express_handle_errors_.md
index b524fa2c68..2f599f957b 100644
--- a/docs/api/core/modules/_express_handle_errors_.md
+++ b/docs/api/core/modules/_express_handle_errors_.md
@@ -23,7 +23,7 @@
**● page500**: *`string`* = 'INTERNAL SERVER ERROR'
+ '
500 - INTERNAL SERVER ERROR
'
-*Defined in [express/handle-errors.ts:6](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/handle-errors.ts#L6)*
+*Defined in [express/handle-errors.ts:6](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/handle-errors.ts#L6)*
___
@@ -35,7 +35,7 @@ ___
▸ **handleErrors**(debug: *`boolean`*, logFn?: *`error`*): `(Anonymous function)`
-*Defined in [express/handle-errors.ts:17](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/express/handle-errors.ts#L17)*
+*Defined in [express/handle-errors.ts:17](https://github.com/FoalTS/foal/blob/70cc46bd/packages/core/src/express/handle-errors.ts#L17)*
Create an express middleware to return a 500 HTML page if an error is thrown and is not caught.
diff --git a/docs/api/core/modules/_express_not_found_.md b/docs/api/core/modules/_express_not_found_.md
index dd4ac17361..db4bcfef75 100644
--- a/docs/api/core/modules/_express_not_found_.md
+++ b/docs/api/core/modules/_express_not_found_.md
@@ -22,7 +22,7 @@
**● page404**: *"<html><head><title>PAGE NOT FOUND</title></head><body><h1>404 - PAGE NOT FOUND</h1></body></html>"* = "PAGE NOT FOUND