@nestia/core 4.5.1 → 4.5.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -74,10 +74,42 @@ export declare function TypedException<T>(props: TypedException.IProps<T>): Meth
74
74
  */
75
75
  export declare function TypedException<T>(status: number | "2XX" | "3XX" | "4XX" | "5XX", description?: string | undefined): MethodDecorator;
76
76
  export declare namespace TypedException {
77
+ /**
78
+ * Properties for the exception.
79
+ */
77
80
  interface IProps<T> {
81
+ /**
82
+ * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
83
+ */
78
84
  status: number | "2XX" | "3XX" | "4XX" | "5XX";
85
+ /**
86
+ * Description about the exception.
87
+ */
79
88
  description?: string | undefined;
80
- example?: T;
81
- examples?: Record<string, T>;
89
+ /**
90
+ * Example value.
91
+ */
92
+ example?: T | undefined;
93
+ /**
94
+ * Collection of examples for the exception.
95
+ */
96
+ examples?: Record<string, IExample<T>> | undefined;
97
+ }
98
+ /**
99
+ * Metadata collected in the {@link IProps.examples}.
100
+ */
101
+ interface IExample<T> {
102
+ /**
103
+ * Summary of the example.
104
+ */
105
+ summary?: string | undefined;
106
+ /**
107
+ * Description of the example.
108
+ */
109
+ description?: string | undefined;
110
+ /**
111
+ * Value of the example.
112
+ */
113
+ value: T;
82
114
  }
83
115
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@nestia/core",
3
- "version": "4.5.1",
3
+ "version": "4.5.2",
4
4
  "description": "Super-fast validation decorators of NestJS",
5
5
  "main": "lib/index.js",
6
6
  "typings": "lib/index.d.ts",
@@ -36,10 +36,10 @@
36
36
  },
37
37
  "homepage": "https://nestia.io",
38
38
  "dependencies": {
39
- "@nestia/fetcher": "^4.5.1",
39
+ "@nestia/fetcher": "^4.5.2",
40
40
  "@nestjs/common": ">=7.0.1",
41
41
  "@nestjs/core": ">=7.0.1",
42
- "@samchon/openapi": "^2.3.0",
42
+ "@samchon/openapi": "^2.3.1",
43
43
  "detect-ts-node": "^1.0.5",
44
44
  "get-function-location": "^2.0.0",
45
45
  "glob": "^7.2.0",
@@ -48,16 +48,16 @@
48
48
  "reflect-metadata": ">=0.1.12",
49
49
  "rxjs": ">=6.0.3",
50
50
  "tgrid": "^1.1.0",
51
- "typia": "^7.5.0",
51
+ "typia": "^7.5.1",
52
52
  "ws": "^7.5.3"
53
53
  },
54
54
  "peerDependencies": {
55
- "@nestia/fetcher": ">=4.5.1",
55
+ "@nestia/fetcher": ">=4.5.2",
56
56
  "@nestjs/common": ">=7.0.1",
57
57
  "@nestjs/core": ">=7.0.1",
58
58
  "reflect-metadata": ">=0.1.12",
59
59
  "rxjs": ">=6.0.3",
60
- "typia": ">=7.5.0 <8.0.0"
60
+ "typia": ">=7.5.1 <8.0.0"
61
61
  },
62
62
  "devDependencies": {
63
63
  "@nestjs/common": "^10.4.13",
@@ -119,10 +119,48 @@ export function TypedException<T>(...args: any[]): MethodDecorator {
119
119
  };
120
120
  }
121
121
  export namespace TypedException {
122
+ /**
123
+ * Properties for the exception.
124
+ */
122
125
  export interface IProps<T> {
126
+ /**
127
+ * Status number or pattern like "2XX", "3XX", "4XX", "5XX".
128
+ */
123
129
  status: number | "2XX" | "3XX" | "4XX" | "5XX";
130
+
131
+ /**
132
+ * Description about the exception.
133
+ */
134
+ description?: string | undefined;
135
+
136
+ /**
137
+ * Example value.
138
+ */
139
+ example?: T | undefined;
140
+
141
+ /**
142
+ * Collection of examples for the exception.
143
+ */
144
+ examples?: Record<string, IExample<T>> | undefined;
145
+ }
146
+
147
+ /**
148
+ * Metadata collected in the {@link IProps.examples}.
149
+ */
150
+ export interface IExample<T> {
151
+ /**
152
+ * Summary of the example.
153
+ */
154
+ summary?: string | undefined;
155
+
156
+ /**
157
+ * Description of the example.
158
+ */
124
159
  description?: string | undefined;
125
- example?: T;
126
- examples?: Record<string, T>;
160
+
161
+ /**
162
+ * Value of the example.
163
+ */
164
+ value: T;
127
165
  }
128
166
  }