@nestjs-architects/typed-cqrs

Enhance the @nestjs/cqrs building blocks with auto-inferring types.

Usage no npm install needed!

<script type="module">
  import nestjsArchitectsTypedCqrs from 'https://cdn.skypack.dev/@nestjs-architects/typed-cqrs';
</script>

README

@nestjs-architects/typed-cqrs

version downloads

Tired of hand-typing types for NestJS CQRS package? We got you covered!

Usage

First install base @nestjs/cqrs package.

$ npm i @nestjs/cqrs

All you need to do, is to extend your query with type of expected response.

import { Query } from '@nestjs-architects/typed-cqrs';

export class GetProfileQuery extends Query<ResultType> {}

Profit

Now, when implementing handler, you get all type completion & safety!

showcase-handler

import { IInferredQueryHandler, QueryHandler } from '@nestjs/cqrs';

@QueryHandler(GetProfileQuery)
export class GetProfileHandler implements IInferredQueryHandler<GetProfileQuery> {}

As well as, results are correctly typed as well! showcase-handler

Development - verify if package works

After running npm run build, run npm link from the root directory to have it visible as globally installed package.

Next, in the project you want to use it, within its root directory, run npm link @nestjs-architects/typed-cqrs