feat: add t helper

glebbash · Jan 17, 2022 · e745e67 · e745e67
1 parent 62ed714
commit e745e67
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -29,7 +29,7 @@ Decorate endpoints:
 */
 import './overrides';
 
-import { Method, NotFound, Ok } from 'typed-http-decorators';
+import { Method, NotFound, Ok, t } from 'typed-http-decorators';
 
 class NotFoundDto {
   constructor(public message: string) {}
@@ -42,8 +42,7 @@ class ResourceDto {
 export class ResourceController {
   @Method.Get('resource/:resourceId', {
     permissions: ['resource.get'],
-    // !!! Do not forget to use `as const`, otherwise TypeScript reports type errors
-    responses: [Ok.Type(ResourceDto), NotFound.Type(NotFoundDto)] as const,
+    responses: t(Ok.Type(ResourceDto), NotFound.Type(NotFoundDto)),
   })
   // You can remove return type annotation and still have type safety
   async getResource(): Promise<Ok<ResourceDto> | NotFound<NotFoundDto>> {
@@ -85,7 +84,7 @@ Controller example:
 import { TypedResponseInterceptor } from '../common/typed-response.interceptor'
 import { Controller, UseInterceptors } from '@nestjs/common'
 import { ApiTags } from '@nestjs/swagger'
-import { Method, Ok } from 'typed-http-decorators'
+import { Method, Ok, t } from 'typed-http-decorators'
 import { FilmsDto } from './dto/films.dto'
 import { FilmsService } from './films.service'
 
@@ -99,7 +98,7 @@ export class FilmsController {
     @Method.Get('', {
         summary: 'Get all films',
         description: 'Gets all films from the database',
-        responses: [Ok.Type(FilmsDto)] as const,
+        responses: t(Ok.Type(FilmsDto)),
     })
     async getAllFilms() {
         return Ok(

diff --git a/src/typed-http-decorators.spec.ts b/src/typed-http-decorators.spec.ts
@@ -8,6 +8,7 @@ import {
   NotFound,
   Ok,
   setEndpointDecorator,
+  t,
 } from './typed-http-decorators';
 
 describe('typed-http-decorators', () => {
@@ -20,7 +21,7 @@ describe('typed-http-decorators', () => {
 
     class ResourceController {
       @Method.Post('resource', {
-        responses: [Created.Type(ResourceDto), Conflict.Type(ConflictDto)] as const,
+        responses: t(Created.Type(ResourceDto), Conflict.Type(ConflictDto)),
       })
       async createResource(id: string) {
         if (Math.random() > 0.5) {
@@ -31,7 +32,7 @@ describe('typed-http-decorators', () => {
       }
 
       @Method.Get('resource/:resourceId', {
-        responses: [Ok.Type(ResourceDto), NotFound.Type(NotFoundDto)] as const,
+        responses: t(Ok.Type(ResourceDto), NotFound.Type(NotFoundDto)),
       })
       async getResource(id: string) {
         if (Math.random() > 0.5) {
@@ -58,7 +59,7 @@ describe('typed-http-decorators', () => {
     const decorateClass = () => {
       class ResourceController {
         @Method.Post('resource', {
-          responses: [Created.Type(ResourceDto)] as const,
+          responses: t(Created.Type(ResourceDto)),
         })
         async createResource() {
           return Created(new ResourceDto('id', 'name'));

diff --git a/src/typed-http-decorators.ts b/src/typed-http-decorators.ts
@@ -7,3 +7,4 @@ export {
 export * as Method from './methods';
 export * from './responses';
 export * from './types';
+export const t = <XS extends readonly unknown[]>(...values: XS): XS => values;