Skip to content

Commit e27c271

Browse files
alpheusmtxalpheusmtx
committed
Updates
1 parent 8c7789a commit e27c271

File tree

25 files changed

+269
-100
lines changed

25 files changed

+269
-100
lines changed

‎apis/hono-zod-validator/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[< Back](./../../README.md)
22

3-
# @jderjs/hono-zod-validator v0.3.0
3+
# @jderjs/hono-zod-validator v0.3.1
44

55
## Functions
66

‎apis/hono-zod-validator/functions/zValidator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ function zValidator<T, Target>(target, schema): MiddlewareHandler<Env, string, {
99
}>;
1010
```
1111

12-
Defined in: [packages/hono-zod-validator/src/index.ts:69](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono-zod-validator/src/index.ts#L69)
12+
Defined in: [packages/hono-zod-validator/src/index.ts:69](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono-zod-validator/src/index.ts#L69)
1313

1414
Validate the request with Zod.
1515

‎apis/hono/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[< Back](./../../README.md)
22

3-
# @jderjs/hono v0.2.0
3+
# @jderjs/hono v0.3.0
44

55
## Modules
66

‎apis/hono/middlewares/body-limit/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ Body limit module
1010
| ------ | ------ |
1111
| [BodyLimitOptions](type-aliases/BodyLimitOptions.md) | Options for `bodyLimit` middleware. |
1212

13+
## Variables
14+
15+
| Variable | Description |
16+
| ------ | ------ |
17+
| [BODY\_LIMIT\_MAX\_DEFAULT](variables/BODY_LIMIT_MAX_DEFAULT.md) | Default maximum body size in bytes. |
18+
1319
## Functions
1420

1521
| Function | Description |

‎apis/hono/middlewares/body-limit/functions/bodyLimit.md

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
# Function: bodyLimit()
44

55
```ts
6-
function bodyLimit(options): MiddlewareHandler;
6+
function bodyLimit(options?): MiddlewareHandler;
77
```
88

9-
Defined in: [packages/hono/src/middlewares/body-limit.ts:52](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/body-limit.ts#L52)
9+
Defined in: [packages/hono/src/middlewares/body-limit.ts:70](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/body-limit.ts#L70)
1010

1111
Body limit middleware.
1212

@@ -26,24 +26,35 @@ Following error will be returned if the body size is over the limit:
2626
For more information, please refer to
2727
[Body Limit](https://hono.dev/docs/middleware/builtin/body-limit).
2828

29-
### Example
29+
### Examples
30+
31+
A example of using `bodyLimit` middleware:
32+
33+
```ts
34+
import { Hono } from "hono";
35+
import { bodyLimit } from "@jderjs/hono/body-limit";
36+
37+
const app: Hono = new Hono();
38+
39+
app.use(bodyLimit());
40+
```
41+
42+
A example of using `bodyLimit` middleware with options:
3043

3144
```ts
3245
import { Hono } from "hono";
3346
import { bodyLimit } from "@jderjs/hono/body-limit";
3447

3548
const app: Hono = new Hono();
3649

37-
app.use(
38-
bodyLimit({
39-
max: 10 * 1024 * 1024, // 10MiB
40-
})
41-
);
50+
app.use(bodyLimit({
51+
max: 20 * 1024 * 1024, // 20MiB
52+
}));
4253
```
4354

4455
## Parameters
4556

46-
### options
57+
### options?
4758

4859
[`BodyLimitOptions`](../type-aliases/BodyLimitOptions.md)
4960

‎apis/hono/middlewares/body-limit/type-aliases/BodyLimitOptions.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@
66
type BodyLimitOptions = object;
77
```
88

9-
Defined in: [packages/hono/src/middlewares/body-limit.ts:13](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/body-limit.ts#L13)
9+
Defined in: [packages/hono/src/middlewares/body-limit.ts:16](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/body-limit.ts#L16)
1010

1111
Options for `bodyLimit` middleware.
1212

1313
## Properties
1414

15-
### max
15+
### max?
1616

1717
```ts
18-
max: number;
18+
optional max: number;
1919
```
2020

21-
Defined in: [packages/hono/src/middlewares/body-limit.ts:15](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/body-limit.ts#L15)
21+
Defined in: [packages/hono/src/middlewares/body-limit.ts:22](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/body-limit.ts#L22)
2222

2323
Maximum body size in bytes.
24+
25+
By default, it is `BODY_LIMIT_MAX_DEFAULT`.

‎apis/hono/middlewares/body-limit/variables/BODY_LIMIT_MAX_DEFAULT.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[@jderjs/hono](../../../README.md) / [middlewares/body-limit](../README.md) / BODY\_LIMIT\_MAX\_DEFAULT
2+
3+
# Variable: BODY\_LIMIT\_MAX\_DEFAULT
4+
5+
```ts
6+
const BODY_LIMIT_MAX_DEFAULT: 10485760;
7+
```
8+
9+
Defined in: [packages/hono/src/middlewares/body-limit.ts:13](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/body-limit.ts#L13)
10+
11+
Default maximum body size in bytes.

‎apis/hono/middlewares/ip-limit/functions/ipLimit.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
function ipLimit(options): MiddlewareHandler;
99
```
1010

11-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:98](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L98)
11+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:98](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L98)
1212

1313
IP limit middleware.
1414

@@ -103,7 +103,7 @@ By default, it's `false`.
103103
function ipLimit(getConnInfo, options?): MiddlewareHandler;
104104
```
105105

106-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:111](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L111)
106+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:111](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L111)
107107

108108
IP limit middleware for compatibility with `hono/ip-restriction`.
109109

‎apis/hono/middlewares/ip-limit/type-aliases/GetIPAddr.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
type GetIPAddr = GetConnInfo | (c) => string;
77
```
88

9-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:20](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L20)
9+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:20](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L20)

‎apis/hono/middlewares/ip-limit/type-aliases/IpLimitBaseOptions.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
type IpLimitBaseOptions = object;
77
```
88

9-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:23](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L23)
9+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:23](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L23)
1010

1111
Base options for `ipLimit` middleware.
1212

@@ -18,7 +18,7 @@ Base options for `ipLimit` middleware.
1818
optional allowList: IPRestrictionRule[];
1919
```
2020

21-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:25](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L25)
21+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:25](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L25)
2222

2323
Allowed IP addresses.
2424

@@ -30,7 +30,7 @@ Allowed IP addresses.
3030
optional denyList: IPRestrictionRule[];
3131
```
3232

33-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:27](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L27)
33+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:27](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L27)
3434

3535
Denied IP addresses.
3636

@@ -42,7 +42,7 @@ Denied IP addresses.
4242
optional verbose: boolean;
4343
```
4444

45-
Defined in: [packages/hono/src/middlewares/ip-limit.ts:32](https://github.com/jder-std/hono/blob/b92633c59fa9113163147663f444d9cb8b0bae4a/packages/hono/src/middlewares/ip-limit.ts#L32)
45+
Defined in: [packages/hono/src/middlewares/ip-limit.ts:32](https://github.com/jder-std/hono/blob/8c7789aedbc9936c4862cd649747186bca01fdb1/packages/hono/src/middlewares/ip-limit.ts#L32)
4646

4747
Whether show more information.
4848
By default, it's `false`.

0 commit comments

Comments
 (0)