Skip to main content

Version 2.7 release notes

· 2 min read
Loïc Poullain
Fullstack developer and creator of FoalTS


Version 2.7 of Foal has been released! Here are the improvements that it brings.

The body of HttpResponse can be typed#

The HttpResponse class becomes generic so as to enforce the type of its body property if needed.

import { Get, HttpResponse } from '@foal/core';
import { Product } from '../entities';
export class AppController {  @Get('/products')  async products(): HttpResponse<Product[]> {    const products = await Product.find({});    return new HttpResponse(products);  }}

It also allows you to infer the type of the body in your tests:

Generic HttpResponse

Support for signed cookies#

Starting from this version, you can sign cookies and read them through the signedCookies attribute.

import { Context, HttpResponseOK, Get, Post } from '@foal/core';
class AppController {  @Get('/')  index(ctx: Context) {    const cookie1: string|undefined = ctx.request.signedCookies.cookie1;    // Do something.    return new HttpResponseOK();  }
  @Post('/sign-cookie')  index() {    return new HttpResponseOK()      .setCookie('cookie1', 'value1', {        signed: true      });  }}

In order to use signed cookies, you must provide a secret with the configuration key settings.cookieParser.secret.

Environment name can be provided via NODE_ENV or FOAL_ENV#

Version 2.7 allows to you to specify the environment name (production, development, etc) with the FOAL_ENV environment variable.

This can be useful if you have third party libraries whose behavior also depends on the value of NODE_ENV (see Github issue here).

foal generate entity and foal generate hook support sub-directories#

Example with entities (models)#

foal g entity userfoal g entity business/product


src/ '- app/  '- entities/   |- business/   | |- product.entity.ts   | '- index.ts   |- user.entity.ts   '- index.ts

Example with hooks#

foal g hook logfoal g hook auth/admin-required


src/ '- app/  '- hooks/   |- auth/   | |- admin-required.hook.ts   | '- index.ts   |- log.hook.ts   '- index.ts

New afterPreMiddlewares option in createApp#

It is now possible to run a custom middleware after all internal Express middlewares of the framework.

This can be useful in rare situations, for example when using the RequestContext helper in Mikro-ORM.

const app = await createApp({   afterPreMiddlewares: [      (req, res, next) => {         RequestContext.create(orm.em, next);      }   ]})


Share this article on

Stay up to date with the newsletter.