feat: add cast array to expected array query params

[BenjD90]

Description

Checklist

• the pull request title describes what this PR does (not a vague title like Update index.md)
• the pull request targets the default branch of the repository (develop)
• the code follows the established code style of the repository
  • npm run prettier:check passes
  • npm run lint:check passes
• tests are added for the changes I made (if any source code was modified)
• documentation added or updated
• I have run the project locally and verified that there are no errors → tests pass

Fixes

Fixes #389, Fixes #320, Fixes #123

The idea is to parse query parameters as it is used to be. I added some exemple in the README, and in the tests :

You can use isArray option to get a query param array. This will cast the query param :

@Get("/users/by-multiple-ids")
getUsers(@QueryParam("ids", { isArray: true}) ids: string[]) {
}

GET /users/by-multiple-ids?ids=a → ids = ['a']
GET /users/by-multiple-ids?ids=a&ids=b → ids = ['a', 'b']

You can combine use isArray option with type option to get a query param array of one type. This will cast the query param :

@Get("/users/by-multiple-ids")
getUsers(@QueryParam("ids", { isArray: true, type: Number}) ids: number[]) {
}

GET /users/by-multiple-ids?ids=1 → ids = [1]
GET /users/by-multiple-ids?ids=1&ids=3.5 → ids = [1, 3.5]

For QueryParams :

enum Roles {
    Admin = "admin",
    User = "user",
    Guest = "guest",
}

class GetUsersQuery {

    @IsPositive()
    limit: number;

    @IsAlpha()
    city: string;

    @IsEnum(Roles)
    role: Roles;

    @IsBoolean()
    isActive: boolean;

    @IsArray()
    @IsNumber(undefined, { each: true })
    @Type(() => Number)
    ids: number[];
}

@Get("/users")
getUsers(@QueryParams() query: GetUsersQuery) {
    // here you can access query.role, query.limit
    // and others valid query parameters
    // query.ids will be an array, of numbers, even with one element
}

[BenjD90]

@NoNameProvided @nolazybits Is it possible to review this PR ?

thanks,
Benjamin

[nolazybits]

Looks good to me but that would be my first review here. I might have missed something. @NoNameProvided might want to double check + I don't think I have write access to this repo (required to have a valid approval) to it won't help unblock this MR

[BenjD90]

I found a bug on boolean management if only one is sent as query param, I'll complete the test with more boolean cases

[BenjD90]

The bug is now fixed 😃
I have added the test @QueryParams should give a proper values from request's query with validate whitelist option on for this specific case.

[github-actions]

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.