Skip to content

Commit 029f80f

Browse files
thetutlagethetutlage
committed
style: adding required docblocks
1 parent 9e36d1e commit 029f80f

File tree

60 files changed

+736
-227
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+736
-227
lines changed

‎adonis-typings/context.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ declare module '@ioc:Adonis/Core/HttpContext' {
1414
import { LoggerContract } from '@ioc:Adonis/Core/Logger'
1515
import { RequestContract } from '@ioc:Adonis/Core/Request'
1616
import { ResponseContract } from '@ioc:Adonis/Core/Response'
17-
import { ServerConfigContract } from '@ioc:Adonis/Core/Server'
17+
import { ServerConfig } from '@ioc:Adonis/Core/Server'
1818
import { ProfilerRowContract } from '@ioc:Adonis/Core/Profiler'
1919
import { EncryptionContract } from '@ioc:Adonis/Core/Encryption'
2020

@@ -50,7 +50,7 @@ declare module '@ioc:Adonis/Core/HttpContext' {
5050
encryption: EncryptionContract,
5151
req?: IncomingMessage,
5252
res?: ServerResponse,
53-
serverConfig?: ServerConfigContract,
53+
serverConfig?: ServerConfig,
5454
): HttpContextContract
5555

5656
new (

‎benchmarks/adonis.ts‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,16 @@ import { Server } from '../standalone'
1818

1919
const logger = new Logger({ enabled: false, level: 'trace', name: 'adonis' })
2020
const profiler = new Profiler(__dirname, logger, { enabled: false })
21-
const encryption = new Encryption('averylongrandom32charslongsecret')
21+
const encryption = new Encryption({
22+
secret: 'averylongrandom32charslongsecret',
23+
})
2224

2325
const server = new Server(new Ioc(), logger, profiler, encryption, {
2426
etag: false,
2527
jsonpCallbackName: 'callback',
2628
cookie: {},
2729
subdomainOffset: 2,
2830
generateRequestId: false,
29-
secret: Math.random().toFixed(36).substring(2, 38),
3031
trustProxy: proxyaddr.compile('loopback'),
3132
allowMethodSpoofing: false,
3233
})

‎docs/README.md‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## Index
66

7-
### External modules
7+
### Modules
88

99
* ["adonis-typings/context"](modules/_adonis_typings_context_.md)
1010
* ["adonis-typings/http-server"](modules/_adonis_typings_http_server_.md)
@@ -17,9 +17,15 @@
1717
* ["benchmarks/fastify"](modules/_benchmarks_fastify_.md)
1818
* ["benchmarks/index"](modules/_benchmarks_index_.md)
1919
* ["providers/HttpServerProvider"](modules/_providers_httpserverprovider_.md)
20+
* ["src/Cookie/Drivers/Encrypted"](modules/_src_cookie_drivers_encrypted_.md)
21+
* ["src/Cookie/Drivers/Plain"](modules/_src_cookie_drivers_plain_.md)
22+
* ["src/Cookie/Drivers/Signed"](modules/_src_cookie_drivers_signed_.md)
23+
* ["src/Cookie/Parser/index"](modules/_src_cookie_parser_index_.md)
24+
* ["src/Cookie/Serializer/index"](modules/_src_cookie_serializer_index_.md)
2025
* ["src/ExceptionManager/index"](modules/_src_exceptionmanager_index_.md)
2126
* ["src/HttpContext/index"](modules/_src_httpcontext_index_.md)
2227
* ["src/MiddlewareStore/index"](modules/_src_middlewarestore_index_.md)
28+
* ["src/Request/index"](modules/_src_request_index_.md)
2329
* ["src/Response/index"](modules/_src_response_index_.md)
2430
* ["src/Router/BriskRoute"](modules/_src_router_briskroute_.md)
2531
* ["src/Router/Group"](modules/_src_router_group_.md)
@@ -33,4 +39,3 @@
3339
* ["src/Server/index"](modules/_src_server_index_.md)
3440
* ["src/helpers"](modules/_src_helpers_.md)
3541
* ["standalone"](modules/_standalone_.md)
36-
* [@poppinss/request](modules/_poppinss_request.md)

‎docs/classes/_src_cookie_parser_index_.cookieparser.md‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
[@adonisjs/http-server](../README.md) › ["src/Cookie/Parser/index"](../modules/_src_cookie_parser_index_.md) › [CookieParser](_src_cookie_parser_index_.cookieparser.md)
2+
3+
# Class: CookieParser
4+
5+
## Hierarchy
6+
7+
* **CookieParser**
8+
9+
## Index
10+
11+
### Constructors
12+
13+
* [constructor](_src_cookie_parser_index_.cookieparser.md#constructor)
14+
15+
### Methods
16+
17+
* [decode](_src_cookie_parser_index_.cookieparser.md#decode)
18+
* [decrypt](_src_cookie_parser_index_.cookieparser.md#decrypt)
19+
* [list](_src_cookie_parser_index_.cookieparser.md#list)
20+
* [unsign](_src_cookie_parser_index_.cookieparser.md#unsign)
21+
22+
## Constructors
23+
24+
### constructor
25+
26+
\+ **new CookieParser**(`cookieHeader`: string, `encryption`: EncryptionContract): *[CookieParser](_src_cookie_parser_index_.cookieparser.md)*
27+
28+
**Parameters:**
29+
30+
Name | Type |
31+
------ | ------ |
32+
`cookieHeader` | string |
33+
`encryption` | EncryptionContract |
34+
35+
**Returns:** *[CookieParser](_src_cookie_parser_index_.cookieparser.md)*
36+
37+
## Methods
38+
39+
### decode
40+
41+
▸ **decode**(`key`: string): *any*
42+
43+
**Parameters:**
44+
45+
Name | Type |
46+
------ | ------ |
47+
`key` | string |
48+
49+
**Returns:** *any*
50+
51+
___
52+
53+
### decrypt
54+
55+
▸ **decrypt**(`key`: string): *any*
56+
57+
**Parameters:**
58+
59+
Name | Type |
60+
------ | ------ |
61+
`key` | string |
62+
63+
**Returns:** *any*
64+
65+
___
66+
67+
### list
68+
69+
▸ **list**(): *object*
70+
71+
**Returns:** *object*
72+
73+
* \[ **key**: *string*\]: any
74+
75+
___
76+
77+
### unsign
78+
79+
▸ **unsign**(`key`: string): *any*
80+
81+
**Parameters:**
82+
83+
Name | Type |
84+
------ | ------ |
85+
`key` | string |
86+
87+
**Returns:** *any*

‎docs/classes/_src_cookie_serializer_index_.cookieserializer.md‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
[@adonisjs/http-server](../README.md) › ["src/Cookie/Serializer/index"](../modules/_src_cookie_serializer_index_.md) › [CookieSerializer](_src_cookie_serializer_index_.cookieserializer.md)
2+
3+
# Class: CookieSerializer
4+
5+
## Hierarchy
6+
7+
* **CookieSerializer**
8+
9+
## Index
10+
11+
### Constructors
12+
13+
* [constructor](_src_cookie_serializer_index_.cookieserializer.md#constructor)
14+
15+
### Methods
16+
17+
* [encode](_src_cookie_serializer_index_.cookieserializer.md#encode)
18+
* [encrypt](_src_cookie_serializer_index_.cookieserializer.md#encrypt)
19+
* [sign](_src_cookie_serializer_index_.cookieserializer.md#sign)
20+
21+
## Constructors
22+
23+
### constructor
24+
25+
\+ **new CookieSerializer**(`encryption`: EncryptionContract): *[CookieSerializer](_src_cookie_serializer_index_.cookieserializer.md)*
26+
27+
**Parameters:**
28+
29+
Name | Type |
30+
------ | ------ |
31+
`encryption` | EncryptionContract |
32+
33+
**Returns:** *[CookieSerializer](_src_cookie_serializer_index_.cookieserializer.md)*
34+
35+
## Methods
36+
37+
### encode
38+
39+
▸ **encode**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
40+
41+
**Parameters:**
42+
43+
Name | Type |
44+
------ | ------ |
45+
`key` | string |
46+
`value` | any |
47+
`options?` | Partial‹CookieOptions› |
48+
49+
**Returns:** *string | null*
50+
51+
___
52+
53+
### encrypt
54+
55+
▸ **encrypt**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
56+
57+
**Parameters:**
58+
59+
Name | Type |
60+
------ | ------ |
61+
`key` | string |
62+
`value` | any |
63+
`options?` | Partial‹CookieOptions› |
64+
65+
**Returns:** *string | null*
66+
67+
___
68+
69+
### sign
70+
71+
▸ **sign**(`key`: string, `value`: any, `options?`: Partial‹CookieOptions›): *string | null*
72+
73+
**Parameters:**
74+
75+
Name | Type |
76+
------ | ------ |
77+
`key` | string |
78+
`value` | any |
79+
`options?` | Partial‹CookieOptions› |
80+
81+
**Returns:** *string | null*

‎docs/classes/_src_exceptionmanager_index_.exceptionmanager.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,14 @@ ___
5656

5757
### registerHandler
5858

59-
▸ **registerHandler**(`handler`: ErrorHandlerNode): *void*
59+
▸ **registerHandler**(`handler`: ErrorHandler): *void*
6060

6161
Register a custom error handler
6262

6363
**Parameters:**
6464

6565
Name | Type |
6666
------ | ------ |
67-
`handler` | ErrorHandlerNode |
67+
`handler` | ErrorHandler |
6868

6969
**Returns:** *void*

‎docs/classes/_src_httpcontext_index_.httpcontext.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ ___
142142

143143
### `Static` create
144144

145-
▸ **create**(`routePattern`: string, `routeParams`: any, `logger`: LoggerContract, `profiler`: ProfilerRowContract, `encryption`: EncryptionContract, `req?`: IncomingMessage, `res?`: ServerResponse, `serverConfig?`: ServerConfigContract): *[HttpContext](_src_httpcontext_index_.httpcontext.md)‹›*
145+
▸ **create**(`routePattern`: string, `routeParams`: any, `logger`: LoggerContract, `profiler`: ProfilerRowContract, `encryption`: EncryptionContract, `req?`: IncomingMessage, `res?`: ServerResponse, `serverConfig?`: ServerConfig): *[HttpContext](_src_httpcontext_index_.httpcontext.md)‹›*
146146

147147
Creates a new fake context instance for a given route.
148148

@@ -157,7 +157,7 @@ Name | Type |
157157
`encryption` | EncryptionContract |
158158
`req?` | IncomingMessage |
159159
`res?` | ServerResponse |
160-
`serverConfig?` | ServerConfigContract |
160+
`serverConfig?` | ServerConfig |
161161

162162
**Returns:** *[HttpContext](_src_httpcontext_index_.httpcontext.md)‹›*
163163

‎docs/classes/_src_middlewarestore_index_.middlewarestore.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,18 @@ Name | Type |
6161

6262
### get
6363

64-
▸ **get**(): *ResolvedMiddlewareNode[]*
64+
▸ **get**(): *ResolvedMiddlewareHandler[]*
6565

6666
Return all middleware registered using [MiddlewareStore.register](_src_middlewarestore_index_.middlewarestore.md#register)
6767
method
6868

69-
**Returns:** *ResolvedMiddlewareNode[]*
69+
**Returns:** *ResolvedMiddlewareHandler[]*
7070

7171
___
7272

7373
### getNamed
7474

75-
▸ **getNamed**(`name`: string): *null | ResolvedMiddlewareNode*
75+
▸ **getNamed**(`name`: string): *null | ResolvedMiddlewareHandler*
7676

7777
Returns a single middleware by it's name registered
7878
using [MiddlewareStore.registerNamed](_src_middlewarestore_index_.middlewarestore.md#registernamed) method.
@@ -83,21 +83,21 @@ Name | Type |
8383
------ | ------ |
8484
`name` | string |
8585

86-
**Returns:** *null | ResolvedMiddlewareNode*
86+
**Returns:** *null | ResolvedMiddlewareHandler*
8787

8888
___
8989

9090
### invokeMiddleware
9191

92-
▸ **invokeMiddleware**(`middleware`: ResolvedMiddlewareNode, `params`: [HttpContextContract, function]): *Promise‹any›*
92+
▸ **invokeMiddleware**(`middleware`: ResolvedMiddlewareHandler, `params`: [HttpContextContract, function]): *Promise‹any›*
9393

9494
Invokes a resolved middleware.
9595

9696
**Parameters:**
9797

9898
Name | Type |
9999
------ | ------ |
100-
`middleware` | ResolvedMiddlewareNode |
100+
`middleware` | ResolvedMiddlewareHandler |
101101
`params` | [HttpContextContract, function] |
102102

103103
**Returns:** *Promise‹any›*
@@ -106,7 +106,7 @@ ___
106106

107107
### register
108108

109-
▸ **register**(`middleware`: MiddlewareNode[]): *this*
109+
▸ **register**(`middleware`: MiddlewareHandler[]): *this*
110110

111111
Register an array of global middleware. These middleware are read
112112
by HTTP server and executed on every request
@@ -115,7 +115,7 @@ by HTTP server and executed on every request
115115

116116
Name | Type |
117117
------ | ------ |
118-
`middleware` | MiddlewareNode[] |
118+
`middleware` | MiddlewareHandler[] |
119119

120120
**Returns:** *this*
121121

0 commit comments

Comments
 (0)