fix(types): add _ prefix to TypedResponse properties (#2917)

honojs · Jun 6, 2024 · 731d7ae · 731d7ae
1 parent cb55866
commit 731d7ae
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 12 deletions.
diff --git a/src/types.test.ts b/src/types.test.ts
@@ -284,29 +284,29 @@ describe('TypedResponse', () => {
   test('unknown', () => {
     type Actual = TypedResponse
     type Expected = {
-      data: unknown
-      status: StatusCode
-      format: ResponseFormat
+      _data: unknown
+      _status: StatusCode
+      _format: ResponseFormat
     }
     type verify = Expect<Equal<Expected, Actual>>
   })
 
   test('text auto infer', () => {
     type Actual = TypedResponse<string>
     type Expected = {
-      data: string
-      status: StatusCode
-      format: 'text'
+      _data: string
+      _status: StatusCode
+      _format: 'text'
     }
     type verify = Expect<Equal<Expected, Actual>>
   })
 
   test('json auto infer', () => {
     type Actual = TypedResponse<{ ok: true }>
     type Expected = {
-      data: { ok: true }
-      status: StatusCode
-      format: 'json'
+      _data: { ok: true }
+      _status: StatusCode
+      _format: 'json'
     }
     type verify = Expect<Equal<Expected, Actual>>
   })

diff --git a/src/types.ts b/src/types.ts
@@ -1753,9 +1753,9 @@ export type TypedResponse<
     ? 'json'
     : ResponseFormat
 > = {
-  data: T
-  status: U
-  format: F
+  _data: T
+  _status: U
+  _format: F
 }
 
 type MergeTypedResponse<T> = T extends Promise<infer T2>