Returning Number causes RangeError

[LefanTan]

Hey folks,

 @Get("/count")
 @Returns(200, Number)
  async getCount(@QueryParams("id") id: string) {
    return 5;
  }

The above code will produce an error like this:

 error: {
    name: 'RangeError',
    message: 'Invalid status code: 5',
    status: 500,
    errors: [],
    stack: 'RangeError: Invalid status code: 5\n' +
      '    at new NodeError (node:internal/errors:371:5)\n' +
      '    at ServerResponse.writeHead (node:_http_server:274:11)\n' +
      '    at ServerResponse.writeHead (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/on-headers/index.js:44:26)\n' +
      '    at ServerResponse._implicitHeader (node:_http_server:265:8)\n' +
      '    at ServerResponse.end (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/compression/index.js:103:14)\n' +
      '    at ServerResponse.send (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/express/lib/response.js:232:10)\n' +
      '    at PlatformResponse.body (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/@tsed/common/src/services/PlatformResponse.ts:281:16)\n' +
      '    at PlatformHandler.flush (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/@tsed/common/src/services/PlatformHandler.ts:100:16)\n' +
      '    at catchAsyncError (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/@tsed/core/src/utils/catchError.ts:11:5)\n' +
      '    at PlatformHandler.onFinish (/Users/lefantan/Documents/CS/vento/packages/webapi/node_modules/@tsed/common/src/services/PlatformHandler.ts:184:18)'
  }

The syntax seems correct to me, let me know if this is a bug.

[Romakita]

It’s probably because in express.js, .send() method consider the given number as a status code and not as a content response.

returning directly a number isn’t correct because a payload is always a text or a json.

Try:

 @Get("/count")
 @Returns(200, String)
  async getCount(@QueryParams("id") id: string) {
    return String(5);
  }

or wrap the payload:

import {object, number} from "@tsed/schema"

 @Get("/count")
 @Returns(200).Schema(object({count: number()}))
  async getCount(@QueryParams("id") id: string) {
    return { count: 5}
  }