Next.js: Adding res.cookie and res.clearCookie in API Routes

[hoangvvo]

Feature request

Is your feature request related to a problem? Please describe.

Having res.cookie and res.clearCookie helper function makes it easier to manipulate cookies in response.

Describe the solution you'd like

Implementing ExpressJS-like res.cookie and res.clearCookie

Describe alternatives you've considered

Using http.ServerResponse response.setHeader(name, value)

Additional context

If this is not possible, how can I implement my own res.cookie and res.clearCookie using middlewares?

[zorrme]

It will be nice if we are able to use express middleware.

[hoangvvo]

I'm closing this issue as it has been solved using Middleware. Thanks @huv1k for that.

api-routes-middleware

Still, I wish we include it in the core of API Routes since we have already has req.cookies anyway. But I understand that it may make API Routes too opinionated.

[XOKP]

I'm closing this issue as it has been solved using Middleware. Thanks @huv1k for that.

api-routes-middleware

Still, I wish we include it in the core of API Routes since we have already has req.cookies anyway. But I understand that it may make API Routes too opinionated.

The middleware does not has the clearCookie function...

[vijaynandwani]

@XOKP I cleared the cookie this way

res.setHeader(
      "Set-Cookie",
      "token=deleted; path=/; expires=Thu, 01 Jan 1970 00:00:00 GMT"
    );

Source

[edshav]

I can't reproduce api-routes-middleware in Typescript because NextApiResponse is a type but not an interface, and property cookie can not be added to res

[farhantahir]

@edshav It is possible with TS, TS now supports extending interface from an object type. I used following and TS didn't gave any error to me.

interface NextResponse extends NextApiResponse {
  cookie(name: string, value: string, options?: CookieSerializeOptions): void
}

[ferlopezm94]

Hi @farhantahir do you know how can we extend NextApiResponse but preserving the same name? There's no problem with NextApiRequest because that is already an interface.