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

moleculer-typed-proxy

v1.0.4

Published

Moleculer proxy to use typed calls

Downloads

670

Readme

Contributors Forks Stargazers Issues MIT License LinkedIn

About The Project

Product Name Screen Shot

The Moleculer is a great framework. However, from the box it is not very typescript friendly. The description of actions and then their subsequent call through a broker are not strongly typed, which can complicate maintenance and refactoring. This library combines the ability to declaratively describe services using decorators, as well as call methods or events using strong typing.

Built With

Getting Started

This is an example of how to use this library. Library provides decorators for simple service definition and ServiceProxyFactory that is used for creating proxies for typed accessing services. Decorators are based on moleculer-service-decorators, so you can find decorator's documentation there.

ServiceProxyFactory has simple interface with ony one method create. The method takes one argument - class definition. See example:

import moleculer, { ServiceBroker } from 'moleculer';
import {
    ServiceProxyFactory,
    service,
    action,
    string,
} from 'moleculer-typed-proxy';

@service({
    name: 'example-service',
})
export class ExampleService extends moleculer.Service {
    @action({
        name: 'say.hello',
    })
    async sayHello(@string() name: string) {
        return `Hello, ${name}!`;
    }
}

const broker = new ServiceBroker();
const factory = new ServiceProxyFactory(broker);

const serviceProxy = factory.create(ExampleService);

serviceProxy.sayHello('Johny').then((result) => {
    // Result has returned via broker, not direct call
    console.log(result);
});

Method create does not create the instance of derived service! It's just using class interface for know hot to call methods or fire events via broker.

Installation

  • npm
    npm install moleculer-typed-proxy
  • yarn
    yarn add moleculer-typed-proxy

Usage

Emitting events:

import moleculer, { ServiceBroker } from 'moleculer';
import {
    ServiceProxyFactory,
    service,
    event,
    string,
    number,
} from 'moleculer-typed-proxy';

@service({
    name: 'logging-service',
})
export class LoggingService extends moleculer.Service {
    @event({
        name: 'user-registered',
    })
    userRegistered(
        @string() login: string,
        @string() name: string,
        @number() age: number,
    ) {
        console.log('User registered', login, name, age);
    }
}

const broker = new ServiceBroker();
const factory = new ServiceProxyFactory(broker);

const serviceProxy = factory.create(LoggingService);

serviceProxy.userRegistered('login', 'name', 25);

Using with inversify:

import moleculer, { ServiceBroker } from 'moleculer';
import {
    ServiceProxyFactory,
    service,
    event,
    string,
    number,
    action,
} from 'moleculer-typed-proxy';
import { Container, inject } from 'inversify';

export class BaseService extends moleculer.Service {
    constructor(
        @inject('ServiceBroker')
            broker: ServiceBroker,
        @inject('ServiceProxyFactory')
        protected readonly proxyFactory: ServiceProxyFactory,
    ) {
        super(broker);
    }
}

@service({
    name: 'user-service',
})
export class UserService extends BaseService {
    @action({
        name: 'register-user',
    })
    registerUser(
        @string() login: string,
        @string() name: string,
        @number() age: number,
    ) {
        // Add user to db
        // ...
        // Emit event of another service
        this.proxyFactory
            .create(LoggingService)
            .userRegistered(login, name, age);
    }
}

@service({
    name: 'logging-service',
})
export class LoggingService extends BaseService {
    @event({
        name: 'user-registered',
    })
    async userRegistered(
        @string() login: string,
        @string() name: string,
        @number() age: number,
    ) {
        console.log('User registered', login, name, age);
    }
}

const container = new Container();
container.bind('ServiceBroker').to(moleculer.ServiceBroker).inSingletonScope();
container
    .bind('ServiceProxyFactory')
    .to(ServiceProxyFactory)
    .inSingletonScope();

// Get proxy
const userServiceProxy = container
    .get<ServiceProxyFactory>(`ServiceProxyFactory`)
    .create(UserService);

// Call action
userServiceProxy.registerUser('login', 'name', 25).then(() => {
    console.log('User created successfully');
});

See examples directory for more examples.

Roadmap

  • [ ] Write e2e tests
  • [ ] Write more complex tests

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Denis Bezrukov - @DenisBezrukov

Project Link: https://github.com/anthrax63/moleculer-typed-proxy