[Docs] Update API docs with beta6

FoalTS · Oct 10, 2018 · 368a787 · 368a787
1 parent 699a338
commit 368a787
Show file tree

Hide file tree

Showing 26 changed files with 639 additions and 392 deletions.
diff --git a/docs/api/index.md b/docs/api/index.md
diff --git a/docs/api/index/config.md b/docs/api/index/config.md
@@ -2,9 +2,9 @@
 
 * [Config][ClassDeclaration-29]
     * Methods
-        * [get(configName, propName, defaultValue)][MethodDeclaration-24]
+        * [get(configName, propName, defaultValue)][MethodDeclaration-30]
     * Properties
-        * [root][PropertyDeclaration-71]
+        * [root][PropertyDeclaration-69]
 
 # Config
 
@@ -44,5 +44,5 @@ public static root: string;
 string
 
 [ClassDeclaration-29]: config.md#config
-[MethodDeclaration-24]: config.md#getconfigname-propname-defaultvalue
-[PropertyDeclaration-71]: config.md#root
+[MethodDeclaration-30]: config.md#getconfigname-propname-defaultvalue
+[PropertyDeclaration-69]: config.md#root
diff --git a/docs/api/index/emailauthenticator.md b/docs/api/index/emailauthenticator.md
@@ -19,7 +19,7 @@ abstract class EmailAuthenticator<User extends EmailUser> implements IAuthentica
 
 | Name | Constraint                          |
 | ---- | ----------------------------------- |
-| User | EmailUser |
+| User | [EmailUser][InterfaceDeclaration-0] |
 ## Methods
 
 ### checkPassword(user, password)
@@ -70,6 +70,7 @@ public abstract entityClass: Class<User>;
 [Class][InterfaceDeclaration-1]<User>
 
 [ClassDeclaration-0]: emailauthenticator.md#emailauthenticator
+[InterfaceDeclaration-0]: ../index.md#emailuser
 [MethodDeclaration-1]: emailauthenticator.md#checkpassworduser-password
 [MethodDeclaration-2]: emailauthenticator.md#authenticate__0
 [PropertyDeclaration-0]: emailauthenticator.md#entityclass

diff --git a/docs/api/index/entityresourcecollection.md b/docs/api/index/entityresourcecollection.md
@@ -2,18 +2,18 @@
 
 * [EntityResourceCollection][ClassDeclaration-26]
     * Methods
-        * [create(user, data, params)][MethodDeclaration-18]
-        * [findById(user, id, params)][MethodDeclaration-19]
-        * [find(user, params)][MethodDeclaration-20]
-        * [modifyById(user, id, data, params)][MethodDeclaration-21]
-        * [updateById(user, id, data, params)][MethodDeclaration-22]
-        * [deleteById(user, id, params)][MethodDeclaration-23]
+        * [create(user, data, params)][MethodDeclaration-24]
+        * [findById(user, id, params)][MethodDeclaration-25]
+        * [find(user, params)][MethodDeclaration-26]
+        * [modifyById(user, id, data, params)][MethodDeclaration-27]
+        * [updateById(user, id, data, params)][MethodDeclaration-28]
+        * [deleteById(user, id, params)][MethodDeclaration-29]
     * Properties
-        * [entityClass][PropertyDeclaration-60]
-        * [allowedOperations][PropertyDeclaration-61]
-        * [middlewares][PropertyDeclaration-62]
-        * [loadedRelations][PropertyDeclaration-63]
-        * [connectionName][PropertyDeclaration-64]
+        * [entityClass][PropertyDeclaration-58]
+        * [allowedOperations][PropertyDeclaration-59]
+        * [middlewares][PropertyDeclaration-60]
+        * [loadedRelations][PropertyDeclaration-61]
+        * [connectionName][PropertyDeclaration-62]
 
 # EntityResourceCollection
 
@@ -166,7 +166,7 @@ public abstract readonly allowedOperations: (keyof IResourceCollection)[];
 
 **Type**
 
-(keyof [IResourceCollection][InterfaceDeclaration-4])[]
+(keyof [IResourceCollection][InterfaceDeclaration-5])[]
 
 ----------
 
@@ -178,7 +178,7 @@ public readonly middlewares: Partial<Record<keyof IResourceCollection, Middlewar
 
 **Type**
 
-Partial<Record<keyof [IResourceCollection][InterfaceDeclaration-4], [Middleware][TypeAliasDeclaration-1]>>[]
+Partial<Record<keyof [IResourceCollection][InterfaceDeclaration-5], [Middleware][TypeAliasDeclaration-1]>>[]
 
 ----------
 
@@ -190,7 +190,7 @@ public readonly loadedRelations: Partial<Record<"find" | "findById", RelationLoa
 
 **Type**
 
-Partial<Record<"find" | "findById", RelationLoader>>
+Partial<Record<"find" | "findById", [RelationLoader][TypeAliasDeclaration-2]>>
 
 ----------
 
@@ -205,24 +205,25 @@ public readonly connectionName: string;
 string
 
 [ClassDeclaration-26]: entityresourcecollection.md#entityresourcecollection
-[MethodDeclaration-18]: entityresourcecollection.md#createuser-data-params
+[MethodDeclaration-24]: entityresourcecollection.md#createuser-data-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[MethodDeclaration-19]: entityresourcecollection.md#findbyiduser-id-params
+[MethodDeclaration-25]: entityresourcecollection.md#findbyiduser-id-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[MethodDeclaration-20]: entityresourcecollection.md#finduser-params
+[MethodDeclaration-26]: entityresourcecollection.md#finduser-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[MethodDeclaration-21]: entityresourcecollection.md#modifybyiduser-id-data-params
+[MethodDeclaration-27]: entityresourcecollection.md#modifybyiduser-id-data-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[MethodDeclaration-22]: entityresourcecollection.md#updatebyiduser-id-data-params
+[MethodDeclaration-28]: entityresourcecollection.md#updatebyiduser-id-data-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[MethodDeclaration-23]: entityresourcecollection.md#deletebyiduser-id-params
+[MethodDeclaration-29]: entityresourcecollection.md#deletebyiduser-id-params
 [ClassDeclaration-1]: abstractuser.md#abstractuser
-[PropertyDeclaration-60]: entityresourcecollection.md#entityclass
+[PropertyDeclaration-58]: entityresourcecollection.md#entityclass
 [InterfaceDeclaration-1]: ../index.md#class
-[PropertyDeclaration-61]: entityresourcecollection.md#allowedoperations
-[InterfaceDeclaration-4]: ../index.md#iresourcecollection
-[PropertyDeclaration-62]: entityresourcecollection.md#middlewares
-[InterfaceDeclaration-4]: ../index.md#iresourcecollection
+[PropertyDeclaration-59]: entityresourcecollection.md#allowedoperations
+[InterfaceDeclaration-5]: ../index.md#iresourcecollection
+[PropertyDeclaration-60]: entityresourcecollection.md#middlewares
+[InterfaceDeclaration-5]: ../index.md#iresourcecollection
 [TypeAliasDeclaration-1]: ../index.md#middleware
-[PropertyDeclaration-63]: entityresourcecollection.md#loadedrelations
-[PropertyDeclaration-64]: entityresourcecollection.md#connectionname
+[PropertyDeclaration-61]: entityresourcecollection.md#loadedrelations
+[TypeAliasDeclaration-2]: ../index.md#relationloader
+[PropertyDeclaration-62]: entityresourcecollection.md#connectionname
diff --git a/docs/api/index/httpresponse.md b/docs/api/index/httpresponse.md
@@ -2,12 +2,18 @@
 
 * [HttpResponse][ClassDeclaration-9]
     * Constructor
-        * [constructor(content)][Constructor-3]
+        * [constructor(body)][Constructor-3]
+    * Methods
+        * [setHeader(name, value)][MethodDeclaration-6]
+        * [getHeader(name)][MethodDeclaration-7]
+        * [getHeaders()][MethodDeclaration-8]
+        * [setCookie(name, value, options)][MethodDeclaration-9]
+        * [getCookie(name)][MethodDeclaration-10]
+        * [getCookies()][MethodDeclaration-11]
     * Properties
         * [isHttpResponse][PropertyDeclaration-21]
-        * [headers][PropertyDeclaration-22]
-        * [statusCode][PropertyDeclaration-23]
-        * [statusMessage][PropertyDeclaration-24]
+        * [statusCode][PropertyDeclaration-22]
+        * [statusMessage][PropertyDeclaration-23]
 
 # HttpResponse
 
@@ -16,44 +22,131 @@ abstract class HttpResponse
 ```
 ## Constructor
 
-### constructor(content)
+### constructor(body)
 
 ```typescript
-public constructor(content?: any);
+public constructor(body?: any);
 ```
 
 **Parameters**
 
-| Name    | Type |
-| ------- | ---- |
-| content | any  |
+| Name | Type |
+| ---- | ---- |
+| body | any  |
 
-## Properties
+## Methods
 
-### isHttpResponse
+### setHeader(name, value)
 
 ```typescript
-public readonly isHttpResponse: true;
+public setHeader(name: string, value: string): void;
 ```
 
-**Type**
+**Parameters**
 
-true
+| Name  | Type   |
+| ----- | ------ |
+| name  | string |
+| value | string |
+
+**Return type**
+
+void
 
 ----------
 
-### headers
+### getHeader(name)
 
 ```typescript
-public headers: { [key: string]: string; };
+public getHeader(name: string): string | undefined;
 ```
 
-**Type**
+**Parameters**
+
+| Name | Type   |
+| ---- | ------ |
+| name | string |
+
+**Return type**
+
+string | undefined
+
+----------
+
+### getHeaders()
+
+```typescript
+public getHeaders(): { [key: string]: string; };
+```
+
+**Return type**
 
 { [key: string]: string; }
 
 ----------
 
+### setCookie(name, value, options)
+
+```typescript
+public setCookie(name: string, value: string, options: CookieOptions = {}): void;
+```
+
+**Parameters**
+
+| Name    | Type                                    | Default value |
+| ------- | --------------------------------------- | ------------- |
+| name    | string                                  |               |
+| value   | string                                  |               |
+| options | [CookieOptions][InterfaceDeclaration-4] | {}            |
+
+**Return type**
+
+void
+
+----------
+
+### getCookie(name)
+
+```typescript
+public getCookie(name: string): { value: string | undefined; options: CookieOptions; };
+```
+
+**Parameters**
+
+| Name | Type   |
+| ---- | ------ |
+| name | string |
+
+**Return type**
+
+{ value: string | undefined; options: [CookieOptions][InterfaceDeclaration-4]; }
+
+----------
+
+### getCookies()
+
+```typescript
+public getCookies(): { [key: string]: { value: string | undefined; options: CookieOptions; }; };
+```
+
+**Return type**
+
+{ [key: string]: { value: string | undefined; options: [CookieOptions][InterfaceDeclaration-4]; }; }
+
+## Properties
+
+### isHttpResponse
+
+```typescript
+public readonly isHttpResponse: true;
+```
+
+**Type**
+
+true
+
+----------
+
 ### statusCode
 
 ```typescript
@@ -77,8 +170,16 @@ public abstract statusMessage: string;
 string
 
 [ClassDeclaration-9]: httpresponse.md#httpresponse
-[Constructor-3]: httpresponse.md#constructorcontent
+[Constructor-3]: httpresponse.md#constructorbody
+[MethodDeclaration-6]: httpresponse.md#setheadername-value
+[MethodDeclaration-7]: httpresponse.md#getheadername
+[MethodDeclaration-8]: httpresponse.md#getheaders
+[MethodDeclaration-9]: httpresponse.md#setcookiename-value-options
+[InterfaceDeclaration-4]: ../index.md#cookieoptions
+[MethodDeclaration-10]: httpresponse.md#getcookiename
+[InterfaceDeclaration-4]: ../index.md#cookieoptions
+[MethodDeclaration-11]: httpresponse.md#getcookies
+[InterfaceDeclaration-4]: ../index.md#cookieoptions
 [PropertyDeclaration-21]: httpresponse.md#ishttpresponse
-[PropertyDeclaration-22]: httpresponse.md#headers
-[PropertyDeclaration-23]: httpresponse.md#statuscode
-[PropertyDeclaration-24]: httpresponse.md#statusmessage
+[PropertyDeclaration-22]: httpresponse.md#statuscode
+[PropertyDeclaration-23]: httpresponse.md#statusmessage
diff --git a/docs/api/index/httpresponsebadrequest.md b/docs/api/index/httpresponsebadrequest.md
@@ -2,11 +2,11 @@
 
 * [HttpResponseBadRequest][ClassDeclaration-14]
     * Constructor
-        * [constructor(content)][Constructor-8]
+        * [constructor(body)][Constructor-8]
     * Properties
-        * [isHttpResponseBadRequest][PropertyDeclaration-33]
-        * [statusCode][PropertyDeclaration-34]
-        * [statusMessage][PropertyDeclaration-35]
+        * [isHttpResponseBadRequest][PropertyDeclaration-32]
+        * [statusCode][PropertyDeclaration-33]
+        * [statusMessage][PropertyDeclaration-34]
 
 # HttpResponseBadRequest
 
@@ -15,17 +15,17 @@ class HttpResponseBadRequest
 ```
 ## Constructor
 
-### constructor(content)
+### constructor(body)
 
 ```typescript
-public constructor(content?: any);
+public constructor(body?: any);
 ```
 
 **Parameters**
 
-| Name    | Type |
-| ------- | ---- |
-| content | any  |
+| Name | Type |
+| ---- | ---- |
+| body | any  |
 
 ## Properties
 
@@ -64,7 +64,7 @@ public statusMessage: string;
 string
 
 [ClassDeclaration-14]: httpresponsebadrequest.md#httpresponsebadrequest
-[Constructor-8]: httpresponsebadrequest.md#constructorcontent
-[PropertyDeclaration-33]: httpresponsebadrequest.md#ishttpresponsebadrequest
-[PropertyDeclaration-34]: httpresponsebadrequest.md#statuscode
-[PropertyDeclaration-35]: httpresponsebadrequest.md#statusmessage
+[Constructor-8]: httpresponsebadrequest.md#constructorbody
+[PropertyDeclaration-32]: httpresponsebadrequest.md#ishttpresponsebadrequest
+[PropertyDeclaration-33]: httpresponsebadrequest.md#statuscode
+[PropertyDeclaration-34]: httpresponsebadrequest.md#statusmessage