Skip to content

Commit fa74652

Browse files
committed
docs: update APIs
1 parent 0e17f47 commit fa74652

9 files changed

Lines changed: 34 additions & 22 deletions

apis/README.md

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

3-
# @jderstd/core v0.4.0
3+
# @jderstd/core v0.5.0
44

55
## Type Aliases
66

@@ -11,6 +11,7 @@
1111
| [HeaderTuple](type-aliases/HeaderTuple.md) | Header tuple. |
1212
| [JsonResponse](type-aliases/JsonResponse.md) | JSON response. |
1313
| [JsonResponseError](type-aliases/JsonResponseError.md) | JSON response error. |
14+
| [JsonResponseErrorInput](type-aliases/JsonResponseErrorInput.md) | Input type for JSON response error. |
1415

1516
## Functions
1617

apis/functions/createJsonResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function createJsonResponse<D>(options?): Response;
77
```
88

9-
Defined in: [response/json/index.ts:54](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/response/json/index.ts#L54)
9+
Defined in: [response/json/index.ts:54](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/response/json/index.ts#L54)
1010

1111
Create a JSON response.
1212

apis/functions/createResponse.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
function createResponse<B>(options?): Response;
77
```
88

9-
Defined in: [response/common/index.ts:40](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/response/common/index.ts#L40)
9+
Defined in: [response/common/index.ts:40](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/response/common/index.ts#L40)
1010

1111
Create a response.
1212

apis/type-aliases/CreateJsonResponseOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
type CreateJsonResponseOptions<D> = CreateJsonResponseStructOptions<D>;
77
```
88

9-
Defined in: [response/json/index.ts:6](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/response/json/index.ts#L6)
9+
Defined in: [response/json/index.ts:6](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/response/json/index.ts#L6)
1010

1111
Options of `createJsonResponse` function.
1212

apis/type-aliases/CreateResponseOptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
type CreateResponseOptions<B> = CreateResponseStructOptions<B>;
77
```
88

9-
Defined in: [response/common/index.ts:6](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/response/common/index.ts#L6)
9+
Defined in: [response/common/index.ts:6](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/response/common/index.ts#L6)
1010

1111
Options of `createResponse` function.
1212

apis/type-aliases/HeaderTuple.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,6 @@
66
type HeaderTuple = [string, string];
77
```
88

9-
Defined in: [@types/response.ts:2](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L2)
9+
Defined in: [@types/response.ts:4](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L4)
1010

1111
Header tuple.

apis/type-aliases/JsonResponse.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
type JsonResponse<D> = object;
77
```
88

9-
Defined in: [@types/response.ts:18](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L18)
9+
Defined in: [@types/response.ts:25](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L25)
1010

1111
JSON response.
1212

@@ -18,25 +18,25 @@ JSON response.
1818

1919
## Properties
2020

21-
### data?
21+
### data
2222

2323
```ts
24-
optional data: D;
24+
data: D | null;
2525
```
2626

27-
Defined in: [@types/response.ts:22](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L22)
27+
Defined in: [@types/response.ts:29](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L29)
2828

2929
Requested information for the response when `success` is `true`.
3030

3131
***
3232

33-
### errors?
33+
### errors
3434

3535
```ts
36-
optional errors: JsonResponseError[];
36+
errors: JsonResponseError[];
3737
```
3838

39-
Defined in: [@types/response.ts:24](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L24)
39+
Defined in: [@types/response.ts:31](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L31)
4040

4141
A list of errors for the response when `success` is `false`.
4242

@@ -48,6 +48,6 @@ A list of errors for the response when `success` is `false`.
4848
success: boolean;
4949
```
5050

51-
Defined in: [@types/response.ts:20](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L20)
51+
Defined in: [@types/response.ts:27](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L27)
5252

5353
Indicates whether the response is successful or not.

apis/type-aliases/JsonResponseError.md

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

9-
Defined in: [@types/response.ts:8](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L8)
9+
Defined in: [@types/response.ts:10](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L10)
1010

1111
JSON response error.
1212

@@ -18,30 +18,30 @@ JSON response error.
1818
code: string;
1919
```
2020

21-
Defined in: [@types/response.ts:10](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L10)
21+
Defined in: [@types/response.ts:12](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L12)
2222

2323
Code representing the error.
2424

2525
***
2626

27-
### message?
27+
### message
2828

2929
```ts
30-
optional message: string;
30+
message: string | null;
3131
```
3232

33-
Defined in: [@types/response.ts:14](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L14)
33+
Defined in: [@types/response.ts:16](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L16)
3434

3535
Detail of the error.
3636

3737
***
3838

39-
### path?
39+
### path
4040

4141
```ts
42-
optional path: string[];
42+
path: string[];
4343
```
4444

45-
Defined in: [@types/response.ts:12](https://github.com/jderstd/javascript/blob/8f7bfc8df2a1c6e65ff47e746ac4d85e2344f847/package/src/@types/response.ts#L12)
45+
Defined in: [@types/response.ts:14](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L14)
4646

4747
Indicates where the error occurred.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[@jderstd/core](../README.md) / JsonResponseErrorInput
2+
3+
# Type Alias: JsonResponseErrorInput
4+
5+
```ts
6+
type JsonResponseErrorInput = Format<Partial<JsonResponseError, "path" | "message">>;
7+
```
8+
9+
Defined in: [@types/response.ts:20](https://github.com/jderstd/javascript/blob/0e17f47863a5f2f0e1f89f9da9574224cbe654ad/package/src/@types/response.ts#L20)
10+
11+
Input type for JSON response error.

0 commit comments

Comments
 (0)