diff --git a/README.md b/README.md index 6fb54ea..f953303 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,10 @@ Simple but effective way to rate limit Tasks in JavaScript. Anything can be rate ## Usage ```js -var ratelimiter = require("@xaymar/ratelimiter"); +var RateLimiter = require("@xaymar/ratelimiter"); -let limitMany = new ratelimiter.RateLimiter(4); -let limitOne = new ratelimiter.RateLimiter(1); +let limitMany = new RateLimiter(4); +let limitOne = new RateLimiter(1); for (let idx = 0; idx < 3; idx++) { limitOne.queue(async () => { @@ -40,10 +40,10 @@ No, but it is relatively easy to do without official support. See the example be ```js // main.js -var ratelimiter = require("@xaymar/ratelimiter"); +var RateLimiter = require("@xaymar/ratelimiter"); let worker = new Worker("worker.js"); -let workerRL = new ratelimiter.RateLimiter(1); +let workerRL = new RateLimiter(1); worker.onmessage = (event) => { worker.resolve(event); diff --git a/source/ratelimiter.ts b/source/ratelimiter.ts index 37f4fbb..1a10a00 100644 --- a/source/ratelimiter.ts +++ b/source/ratelimiter.ts @@ -24,11 +24,11 @@ interface RateLimiterInstance { solver?: Promise, } -export type RateLimiterAsyncExecutor = (...args: any[]) => Promise; -export type RateLimiterSyncExecutor = (...args: any[]) => any; -export type RateLimiterExecutor = RateLimiterSyncExecutor | RateLimiterAsyncExecutor; +type RateLimiterAsyncExecutor = (...args: any[]) => Promise; +type RateLimiterSyncExecutor = (...args: any[]) => any; +type RateLimiterExecutor = RateLimiterSyncExecutor | RateLimiterAsyncExecutor; -export class RateLimiter { +export default class RateLimiter { private _maximum: number = 0; private _available: number = 0; private _instances: any[];