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

grpc-powerkit

v1.0.6

Published

A powerful and elegant TypeScript-based gRPC server framework with decorators

Downloads

563

Readme

grpc-powerkit

A powerful and elegant TypeScript-based gRPC server framework with decorators support.

Features

  • 🚀 Decorator-based routing and service configuration
  • 💪 Strong TypeScript support
  • 🛡️ Built-in error handling
  • 🔌 Easy service registration

Installation

npm install grpc-powerkit

Quick Start

  1. Define your proto file:
syntax = "proto3";

package hello;

service HelloService {
  rpc SayHello (HelloRequest) returns (HelloResponse);
}

message HelloRequest {
  string name = 1;
}

message HelloResponse {
  string message = 1;
}
  1. Create your service:
import { GrpcService, GrpcMethod, GrpcError, status } from 'grpc-powerkit';

@GrpcService({
  protoPath: './proto/hello.proto',
  package: 'hello',
  service: 'HelloService'
})
class HelloController {
  @GrpcMethod('HelloService', 'SayHello')
  async sayHello(request: { name: string }) {
    if (!request.name) {
      throw new GrpcError('Name is required', status.INVALID_ARGUMENT);
    }
    return { message: `Hello ${request.name}!` };
  }
}
  1. Start the server:
import { GrpcServer } from 'grpc-powerkit';

async function bootstrap() {
  const server = new GrpcServer({
    port: 50051,
    keepCase: true
  });

  server.addController(HelloController);
  await server.start();
}

bootstrap();

API Reference

Decorators

@GrpcService(config: GrpcServiceConfig)

Defines a gRPC service configuration for a controller class.

interface GrpcServiceConfig {
  protoPath: string;     // Path to the proto file
  package: string;       // Proto package name
  service: string;       // Service name
  protoOptions?: Options; // Proto loader options
}

@GrpcMethod(service: string, method: string)

Defines a gRPC method handler.

Classes

GrpcServer

The main server class that handles service registration and lifecycle.

interface GrpcServerConfig {
  port: number;        // Server port
  host?: string;       // Server host (default: '0.0.0.0')
  keepCase?: boolean;  // Keep proto case (default: true)
  secure?: boolean;    // Use secure credentials
}

GrpcError

Custom error class for handling gRPC errors.

new GrpcError(message: string, code: status = status.INTERNAL, details?: any)

Error Handling

The framework provides built-in error handling through the GrpcError class:

throw new GrpcError('Invalid input', status.INVALID_ARGUMENT, { field: 'name' });

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License - see the LICENSE file for details.