style: inline constructor arguments

Author: thetutlage

docs/classes/_src_cookie_parser_index_.cookieparser.md

@@ -2,6 +2,15 @@
 
 # Class: CookieParser
 
+Cookie parser parses the HTTP `cookie` method and collects all cookies
+inside an object of `key-value` pair, but doesn't attempt to decrypt
+or unsign or decode the individual values.
+
+The cookie values are lazily decrypted, or unsigned to avoid unncessary
+processing, which infact can be used as a means to burden the server
+by sending too many cookies which even doesn't belongs to the
+server.
+
 ## Hierarchy
 
 * **CookieParser**
@@ -38,36 +47,47 @@ Name | Type |
 
 ###  decode
 
-▸ **decode**(`key`: string): *any*
+▸ **decode**(`key`: string): *any | null*
+
+Attempts to decode a cookie by the name. When calling this method,
+you are assuming that the cookie was just encoded at the first
+place and not signed or encrypted.
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
 `key` | string |
 
-**Returns:** *any*
+**Returns:** *any | null*
 
 ___
 
 ###  decrypt
 
-▸ **decrypt**(`key`: string): *any*
+▸ **decrypt**(`key`: string): *null | any*
+
+Attempts to decrypt a cookie by the name. When calling this method,
+you are assuming that the cookie was encrypted at the first place.
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
 `key` | string |
 
-**Returns:** *any*
+**Returns:** *null | any*
 
 ___
 
 ###  list
 
 ▸ **list**(): *object*
 
+Returns an object of cookies key-value pair. Do note, the
+cookies are not decoded, unsigned or decrypted inside this
+list.
+
 **Returns:** *object*
 
 * \[ **key**: *string*\]: any
@@ -76,12 +96,15 @@ ___
 
 ###  unsign
 
-▸ **unsign**(`key`: string): *any*
+▸ **unsign**(`key`: string): *null | any*
+
+Attempts to unsign a cookie by the name. When calling this method,
+you are assuming that the cookie was signed at the first place.
 
 **Parameters:**
 
 Name | Type |
 ------ | ------ |
 `key` | string |
 
-**Returns:** *any*
+**Returns:** *null | any*

docs/classes/_src_cookie_serializer_index_.cookieserializer.md

@@ -2,6 +2,10 @@
 
 # Class: CookieSerializer
 
+Cookies serializer is used to serialize a value to be set on the `Set-Cookie`
+header. You can `encode`, `sign` on `encrypt` cookies using the serializer
+and then set them individually using the `set-cookie` header.
+
 ## Hierarchy
 
 * **CookieSerializer**
@@ -38,6 +42,14 @@ Name | Type |
 
 ▸ **encode**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
 
+Encodes value as a plain cookie. Do note, the value is still JSON.stringified
+and converted to base64 encoded string to avoid encoding issues.
+
+**`example`** 
+```ts
+ serializer.encode('name', 'virk')
+```
+
 **Parameters:**
 
 Name | Type |
@@ -54,6 +66,8 @@ ___
 
 ▸ **encrypt**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
 
+Encrypts the value and returns it back as a url safe string.
+
 **Parameters:**
 
 Name | Type |
@@ -70,6 +84,9 @@ ___
 
 ▸ **sign**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
 
+Signs the value and returns it back as a url safe string. The signed value
+has a verification hash attached to it to detect data tampering.
+
 **Parameters:**
 
 Name | Type |

docs/modules/_src_cookie_drivers_encrypted_.md

@@ -16,6 +16,9 @@
 
 ▸ **canUnpack**(`encryptedValue`: string): *boolean*
 
+Returns a boolean, if the unpack method from this module can attempt
+to unpack encrypted value.
+
 **Parameters:**
 
 Name | Type |
@@ -30,6 +33,8 @@ ___
 
 ▸ **pack**(`key`: string, `value`: any, `encryption`: EncryptionContract): *null | string*
 
+Encrypt a value to be set as cookie
+
 **Parameters:**
 
 Name | Type |
@@ -46,6 +51,10 @@ ___
 
 ▸ **unpack**(`key`: string, `encryptedValue`: string, `encryption`: EncryptionContract): *null | any*
 
+Attempts to unpack the encrypted cookie value. Returns null, when fails to do so.
+Only call this method, when `canUnpack` returns true, otherwise runtime
+exceptions can be raised.
+
 **Parameters:**
 
 Name | Type |

docs/modules/_src_cookie_drivers_plain_.md

@@ -16,6 +16,9 @@
 
 ▸ **canUnpack**(`encodedValue`: string): *boolean*
 
+Returns true when this `unpack` method of this module can attempt
+to unpack the encode value.
+
 **Parameters:**
 
 Name | Type |
@@ -30,6 +33,9 @@ ___
 
 ▸ **pack**(`value`: any): *null | string*
 
+Encodes a value into a base64 url encoded string to
+be set as cookie
+
 **Parameters:**
 
 Name | Type |
@@ -44,6 +50,9 @@ ___
 
 ▸ **unpack**(`encodedValue`: string): *null | any*
 
+Attempts to unpack the value by decoding it. Make sure to call, `canUnpack`
+before calling this method
+
 **Parameters:**
 
 Name | Type |

docs/modules/_src_cookie_drivers_signed_.md

@@ -16,6 +16,9 @@
 
 ▸ **canUnpack**(`signedValue`: string): *boolean*
 
+Returns a boolean, if the unpack method from this module can attempt
+to unpack the signed value.
+
 **Parameters:**
 
 Name | Type |
@@ -30,6 +33,9 @@ ___
 
 ▸ **pack**(`key`: string, `value`: any, `encryption`: EncryptionContract): *null | string*
 
+Signs a value to be shared as a cookie. The signed output has a
+hash to verify tampering with the original value
+
 **Parameters:**
 
 Name | Type |
@@ -46,6 +52,9 @@ ___
 
 ▸ **unpack**(`key`: string, `signedValue`: string, `encryption`: EncryptionContract): *null | any*
 
+Attempts to unpack the signed value. Make sure to call `canUnpack` before
+calling this method.
+
 **Parameters:**
 
 Name | Type |

src/Server/PreCompiler/index.ts

@@ -88,10 +88,7 @@ export class PreCompiler {
    */
   private resolver: IocResolverContract
 
-  constructor (
-    container: IocContract,
-    private middlewareStore: MiddlewareStoreContract,
-  ) {
+  constructor (container: IocContract, private middlewareStore: MiddlewareStoreContract) {
     this.resolver = container.getResolver(undefined, 'httpControllers', 'App/Controllers/Http')
   }