Gathering detailed insights and metrics for express-typed-rpc
Installations
npm install express-typed-rpcDeveloper Guide
BETA
Typescript
No
Module System
N/A
Node Version
21.6.1
NPM Version
10.2.4
Score
65.3
Supply Chain
96.8
Quality
73.6
Maintenance
100
Vulnerability
100
License
Releases
15
Contributors
1
Unable to fetch Contributors
Languages
1
TypeScript
TypeScript (100%)
validate.email 🚀
Verify real, reachable, and deliverable emails with instant MX records, SMTP checks, and disposable email detection.
Developer
mhweiner
Download Statistics
Total Downloads
3,974
Last Day
2
Last Week
11
Last Month
77
Last Year
2,032
GitHub Statistics
MIT License
3 Stars
27 Commits
2 Watchers
1 Branches
1 Contributors
Updated on Jul 04, 2024
Maintainers
1
Package Meta Information
Latest Version
2.0.0
Package Id
express-typed-rpc@2.0.0
Unpacked Size
21.49 kB
Size
7.15 kB
File Count
21
NPM Version
10.2.4
Node Version
21.6.1
Published on
Jan 29, 2024
Total Downloads
Cumulative downloads
Total Downloads
3,974
Last Day
0%
2
Compared to previous day
Last Week
83.3%
11
Compared to previous week
Last Month
-39.4%
77
Compared to previous month
Last Year
4.6%
2,032
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
express-typed-rpc
WARNING! This repo is still a work in progress. Please contribute if you're interested ❤️
Simple express middleware to easily create a fully-typed JSON API over HTTP on both the server-side and client-side. This project is inspired by tRPC, but much simpler.
Crazy Simple and Easy to Use 😃
- Works out of the box with express and Typescript
- No magic or black boxes
- No code generation or build steps! Works 100% statically via Typescript's
inferkeyword - No writing type specifications
- Minimal configuration
- Client included!
- Tiny codebase (~50LOC) with minimal dependencies. Written in clean, simple Typescript. Contribute or fork and make it your own.
Make Your Code More Reliable and Go Faster! 🚀
- Take advantage of Typescript and turn your runtime errors into compiler-time errors! Inputs and outputs are both fully typed.
- Easily unit-test your express handlers since they are now no longer dependent on
reqandres
Installation
1npm i express-typed-rpc
Example Usage
server.ts
1import express from 'express'; 2import { Router } from 'express'; 3import { createAPI, InferAPI } from 'express-typed-rpc/dist/server'; 4 5const apiRouter = Router(); 6 7const api = { 8 greet: (name: string): string => `Hello, ${name}!`, 9 multiply: (args: {a: number, b: number}): number => args.a * args.b 10}; 11 12createAPI(apiRouter, api); 13 14// Export type for use on client 15export type API = InferAPI<typeof api>; 16 17const app = express(); 18 19app.use('/api', apiRouter); 20app.listen(process.env.PORT || 3000);
dom-client.ts
1import {client} from 'express-typed-rpc/dist/client'; 2import type {API} from '@yourorg/server' 3 4const greet = async (name: string): Promise<string> => { 5 return await client<API['greet']>('greet', name, { 6 endpoint: 'https://api.yourdomain.com', 7 options: {} // fetch options (window.RequestInit) 8 }); 9}; 10 11const multiply = async (numbers: {a: number, b: number}): Promise<number> => { 12 return await client<API['multiply']>('multiply', numbers, { 13 endpoint: 'https://api.yourdomain.com', 14 options: {} // fetch options (window.RequestInit) 15 }); 16};
node-client.ts
1import {client} from 'express-typed-rpc/dist/client-node'; 2import type {API} from '@yourorg/server' 3 4const greet = async (name: string): Promise<string> => { 5 return await client<API['greet']>('greet', name, { 6 endpoint: 'https://api.yourdomain.com', 7 options: {} // https.RequestOptions 8 }); 9}; 10 11const multiply = async (numbers: {a: number, b: number}): Promise<number> => { 12 return await client<API['multiply']>('multiply', numbers, { 13 endpoint: 'https://api.yourdomain.com', 14 options: {} // https.RequestOptions 15 }); 16};
You must publish your backend as a private repo (Github Packages is recommended). Only the Typescript types are exported/imported and does not affect runtime. You will enjoy the same performance but with IDE autocompletion, validation, and compile-time TypeScript errors.
Contribution
Please contribute to this project! Issue a PR against main and request review.
- Please test your work thoroughly.
- Make sure all tests pass with appropriate coverage.
How to build locally
1npm i
Running tests
1npm test
No vulnerabilities found.
No security vulnerabilities found.