npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-cqs

v0.1.0

Published

Lightweight Command and Query Separation library

Downloads

8

Readme

CircleCI Test Coverage Maintainability npm version Known Vulnerabilities

ts-cqs

Light Command and Query Separation framework for typescript that uses inversify for dependency injection.

:warning: Note, this is not a CQRS library

Motivation

Following the single responsibility principle, the command and query separation pattern works well. This library sets out to provide a framework in to replicate the CQS pattern in typescript that uses the dependency injection framework InversifyJs.

There are CQRS libraries such as NestJS/CQRS that provides a framework for this pattern. However, it adheres more to the CQRS pattern with event sourcing and uses the bus (command/query processor) as a way to wire up the dependency injection. This library allows you to wire up the dependencies outside of the processors.

Installation

npm install ts-cqs inversify reflect-metadata --save

The InversifyJS type definitions are included in the inversify npm package.

:warning: Important! ts-cqs requires has a peer dependency on InversifyJs, please view their readme for their requirements.

Usage

Commands

// TestCommand.ts

import 'reflect-metadata'
import { injectable } from 'inversify'
import { ICommand, ICommandHandler, CommandHandler } from 'ts-cqs'

export class TestCommand implements ICommand<string> {
  constructor(public readonly val: string) {}
}

@injectable()
@CommandHandler(TestCommand)
export class TestCommandHandler implements ICommandHandler<TestCommand> {
  async handle(command: TestCommand): Promise<string> {
    return command.val
  }
}

ICommandHandler.execute is set to return any. In this case, command handlers can chose to return something or not.

// CompositeRoot.ts

import { Container } from 'inversify'
import { TestCommandHandler } from './TestCommand'

const container = new Container()
container.bind(TestCommandHandler).toSelf()

The inversify binding here uses the handler class as the id. See docs

// SomeConsumerClass.ts

import { CommandProcessor } from 'ts-cqs'
import { TestCommand } from './TestCommand'

export class SomeConsumerClass {
  constructor(private commandProcessor: CommandProcessor) {}

  async use(): Promise<string> {
    const testCommand = new TestCommand('some value')
    const commandResult = await this.commandProcessor.execute(testCommand)

    console.log(commandResult) // logs 'some value'
  }
}

Contributing

Tests

npm run test