octokit-load-balancer 1.0.2 → 1.0.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +2 -13
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -59,17 +59,6 @@ Every time you call `getApp(config)`:
59
59
 
60
60
  App configs use `GitHubAppConfig` (re-exported from `@octokit/auth-app`'s `StrategyOptions`). All apps must have valid `appId` and `privateKey` — incomplete configs will throw an error.
61
61
 
62
- ## Comparison with @octokit/plugin-throttling
62
+ ## Scalability
63
63
 
64
- [`@octokit/plugin-throttling`](https://github.com/octokit/plugin-throttling.js) handles rate limits by queuing and retrying requests. This library takes a different approach: distribute load across multiple GitHub Apps to maximize available quota.
65
-
66
- | | octokit-load-balancer | plugin-throttling |
67
- | ------------------ | ---------------------------------- | ------------------------- |
68
- | Strategy | Pick app with most remaining quota | Queue and retry on limits |
69
- | Multiple apps | Yes | No |
70
- | Handles exhaustion | Throws | Waits and retries |
71
-
72
- Choose based on your situation:
73
-
74
- - **Need more than 5000 requests/hour?** → Create multiple GitHub Apps and use this library to distribute load across them (N apps = N × 5000 req/hr)
75
- - **Single app, need graceful handling?** → Use plugin-throttling to wait and retry
64
+ This library is designed for high-throughput scenarios where a single GitHub App's rate limit (5,000 requests/hour) isn't enough. By distributing requests across multiple apps, you get N × 5,000 requests/hour.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "octokit-load-balancer",
3
- "version": "1.0.2",
3
+ "version": "1.0.3",
4
4
  "description": "Load balance across multiple GitHub App instances, always picking the one with most available rate limit",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/index.mjs",
@@ -41,7 +41,7 @@
41
41
  },
42
42
  "repository": {
43
43
  "type": "git",
44
- "url": "https://github.com/frankie303/octokit-load-balancer"
44
+ "url": "git+https://github.com/frankie303/octokit-load-balancer.git"
45
45
  },
46
46
  "peerDependencies": {
47
47
  "@octokit/auth-app": "^7.0.0",