feat(paginator) convert Order type to enum

[devx-opensource]

Avoid using string literals while allowing a developer to use the type at runtime as an enum

• [x] Tests are passing with a small update to check both usage (literal string like ASC and enum type like Order.ASC)
• [x] No breaking changes
• [x] Make Order type available as enum at runtime

---

Hi!

I made a small change converting the Order type into an Enum. It allows a better use of the type in my opinion. With that feature, I'm able to do the following in my DTO:

import { IsInt,  } from 'class-validator';
import { Order } from 'typeorm-cursor-pagination';
import { ApiProperty } from '@nestjs/swagger';

export class PaginationDto<Entity> {
  // ...

  @IsIn(Object.values(Order))
  @ApiProperty({
    enum: Order,
  })
  order: Order = Order.DESC;

}

instead of

import { IsInt,  } from 'class-validator';
import { Order } from 'typeorm-cursor-pagination';
import { ApiProperty } from '@nestjs/swagger';

export class PaginationDto<Entity> {
  // ...

  @IsIn(['ASC', 'DESC'])
  @ApiProperty({
    enum: ['ASC', 'DESC'],
  })
  order: Order = 'DESC';

}

[benjamin658]

Thanks again for your contribution!

Would you mind amending the commit message to feat(paginator): ..., so that the changelog generator can include this change.

Force push is ok to me.

[devx-opensource]

Thanks again for your contribution!

Would you mind amending the commit message to feat(paginator): ..., so that the changelog generator can include this change.

Force push is ok to me.

Done! I also reworked my test from the previous PR. It wasn't deterministic and would fail sometime.

Have a nice weekend.

[benjamin658]

Thanks again, I will do the release tomorrow.

[benjamin658]

The changes are included in the release v0.8.1.