Skip to content

Commit

Permalink
[Docs] Update API reference
Browse files Browse the repository at this point in the history
  • Loading branch information
LoicPoullain committed Sep 26, 2019
1 parent 538afb2 commit 9e77e4e
Show file tree
Hide file tree
Showing 191 changed files with 1,053 additions and 885 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/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/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L9)*

**Parameters:**

Expand All @@ -61,7 +61,7 @@ ___

**● content**: *`any`*

*Defined in [common/errors/object-does-not-exist.ts:11](https://github.com/FoalTS/foal/blob/aac11366/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/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L11)*

___
<a id="isobjectdoesnotexist"></a>
Expand All @@ -70,7 +70,7 @@ ___

**● isObjectDoesNotExist**: *`true`* = true

*Defined in [common/errors/object-does-not-exist.ts:9](https://github.com/FoalTS/foal/blob/aac11366/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/538afb23/packages/core/src/common/errors/object-does-not-exist.ts#L9)*

___
<a id="message"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/packages/core/src/common/errors/permission-denied.ts#L9)*
*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L9)*

**Parameters:**

Expand All @@ -61,7 +61,7 @@ ___

**● content**: *`any`*

*Defined in [common/errors/permission-denied.ts:11](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/common/errors/permission-denied.ts#L11)*
*Defined in [common/errors/permission-denied.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L11)*

___
<a id="ispermissiondenied"></a>
Expand All @@ -70,7 +70,7 @@ ___

**● isPermissionDenied**: *`true`* = true

*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/common/errors/permission-denied.ts#L9)*
*Defined in [common/errors/permission-denied.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/permission-denied.ts#L9)*

___
<a id="message"></a>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/packages/core/src/common/errors/validation-error.ts#L9)*
*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L9)*

**Parameters:**

Expand All @@ -61,7 +61,7 @@ ___

**● content**: *`any`*

*Defined in [common/errors/validation-error.ts:11](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/common/errors/validation-error.ts#L11)*
*Defined in [common/errors/validation-error.ts:11](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L11)*

___
<a id="isvalidationerror"></a>
Expand All @@ -70,7 +70,7 @@ ___

**● isValidationError**: *`true`* = true

*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/common/errors/validation-error.ts#L9)*
*Defined in [common/errors/validation-error.ts:9](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/common/errors/validation-error.ts#L9)*

___
<a id="message"></a>
Expand Down
30 changes: 15 additions & 15 deletions docs/api/core/classes/_core_config_.config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/packages/core/src/core/config.ts#L91)*
*Defined in [core/config.ts:91](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L91)*

___

Expand All @@ -63,7 +63,7 @@ ___

**get**<`T`>(key: *`string`*, defaultValue?: *[T]()*): `T`

*Defined in [core/config.ts:225](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L225)*
*Defined in [core/config.ts:225](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L225)*

Access environment variables and configuration files.

Expand Down Expand Up @@ -102,7 +102,7 @@ ___

**clearCache**(): `void`

*Defined in [core/config.ts:83](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L83)*
*Defined in [core/config.ts:83](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L83)*

Clear the cache of the loaded files.

Expand All @@ -119,7 +119,7 @@ ___

**convertType**(value: *`string`*): `boolean` \| `number` \| `string`

*Defined in [core/config.ts:172](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L172)*
*Defined in [core/config.ts:172](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L172)*

**Parameters:**

Expand All @@ -136,7 +136,7 @@ ___

**dotToUnderscore**(str: *`string`*): `string`

*Defined in [core/config.ts:165](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L165)*
*Defined in [core/config.ts:165](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L165)*

**Parameters:**

Expand All @@ -153,7 +153,7 @@ ___

**get**<`T`>(key: *`string`*, defaultValue?: *[T]()*): `T`

*Defined in [core/config.ts:39](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L39)*
*Defined in [core/config.ts:39](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L39)*

Access environment variables and configuration files.

Expand Down Expand Up @@ -194,7 +194,7 @@ ___

**getValue**(config: *`object`*, propertyPath: *`string`*): `any`

*Defined in [core/config.ts:189](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L189)*
*Defined in [core/config.ts:189](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L189)*

**Parameters:**

Expand All @@ -212,7 +212,7 @@ ___

**getYAMLInstance**(): `false` \| `any`

*Defined in [core/config.ts:150](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L150)*
*Defined in [core/config.ts:150](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L150)*

**Returns:** `false` \| `any`

Expand All @@ -223,7 +223,7 @@ ___

**readDotEnvValue**(name: *`string`*): `string` \| `boolean` \| `number` \| `undefined`

*Defined in [core/config.ts:98](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L98)*
*Defined in [core/config.ts:98](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L98)*

**Parameters:**

Expand All @@ -240,7 +240,7 @@ ___

**readJSONValue**(path: *`string`*, key: *`string`*): `any`

*Defined in [core/config.ts:118](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L118)*
*Defined in [core/config.ts:118](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L118)*

**Parameters:**

Expand All @@ -258,7 +258,7 @@ ___

**readYAMLValue**(path: *`string`*, key: *`string`*): `any`

*Defined in [core/config.ts:131](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L131)*
*Defined in [core/config.ts:131](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L131)*

**Parameters:**

Expand All @@ -279,15 +279,15 @@ ___

**cache**: *`object`*

*Defined in [core/config.ts:92](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L92)*
*Defined in [core/config.ts:92](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L92)*

<a id="cache.dotenv"></a>

#### dotEnv

**● dotEnv**: *`undefined`* = undefined

*Defined in [core/config.ts:93](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L93)*
*Defined in [core/config.ts:93](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L93)*

___
<a id="cache.json"></a>
Expand All @@ -296,7 +296,7 @@ ___

**● json**: *`object`*

*Defined in [core/config.ts:94](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L94)*
*Defined in [core/config.ts:94](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L94)*

#### Type declaration

Expand All @@ -307,7 +307,7 @@ ___

**● yaml**: *`object`*

*Defined in [core/config.ts:95](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config.ts#L95)*
*Defined in [core/config.ts:95](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config.ts#L95)*

#### Type declaration

Expand Down
8 changes: 4 additions & 4 deletions docs/api/core/classes/_core_config_mock_.configmock.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/packages/core/src/core/config-mock.ts#L12)*
*Defined in [core/config-mock.ts:12](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L12)*

___

Expand All @@ -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/aac11366/packages/core/src/core/config-mock.ts#L34)*
*Defined in [core/config-mock.ts:34](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L34)*

Return the config value previously given with ConfigMock.set.

Expand Down Expand Up @@ -80,7 +80,7 @@ ___

**reset**(): `void`

*Defined in [core/config-mock.ts:43](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config-mock.ts#L43)*
*Defined in [core/config-mock.ts:43](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L43)*

Clear every config value previously given with Config.set.

Expand All @@ -95,7 +95,7 @@ ___

**set**(key: *`string`*, value: *`any`*): `void`

*Defined in [core/config-mock.ts:21](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/config-mock.ts#L21)*
*Defined in [core/config-mock.ts:21](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/config-mock.ts#L21)*

Set an configuration variable.

Expand Down
10 changes: 5 additions & 5 deletions docs/api/core/classes/_core_http_contexts_.context.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/aac11366/packages/core/src/core/http/contexts.ts#L19)*
*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L19)*

Creates an instance of Context.

Expand All @@ -69,7 +69,7 @@ ___

**● request**: *`Request`*

*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/http/contexts.ts#L19)*
*Defined in [core/http/contexts.ts:19](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L19)*

___
<a id="session"></a>
Expand All @@ -78,7 +78,7 @@ ___

**● session**: *`ContextSession`*

*Defined in [core/http/contexts.ts:18](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/http/contexts.ts#L18)*
*Defined in [core/http/contexts.ts:18](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L18)*

___
<a id="state"></a>
Expand All @@ -87,7 +87,7 @@ ___

**● state**: *`object`*

*Defined in [core/http/contexts.ts:16](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/http/contexts.ts#L16)*
*Defined in [core/http/contexts.ts:16](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L16)*

#### Type declaration

Expand All @@ -100,7 +100,7 @@ ___

**● user**: *`User`*

*Defined in [core/http/contexts.ts:17](https://github.com/FoalTS/foal/blob/aac11366/packages/core/src/core/http/contexts.ts#L17)*
*Defined in [core/http/contexts.ts:17](https://github.com/FoalTS/foal/blob/538afb23/packages/core/src/core/http/contexts.ts#L17)*

___

Loading

0 comments on commit 9e77e4e

Please sign in to comment.