@amazon/vinyl-util 3.2.1 → 3.2.3-next.20261001143710

package/dist/types/current/util/fun/rateLimit.js

@@ -0,0 +1,86 @@
+/*
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { DisposedError } from '../../core/disposable';
+import { IllegalArgumentError } from '../../error/IllegalArgumentError';
+import { TimeoutSlot } from '../async/TimeoutSlot';
+/**
+ * Rate-limits invocations with a token bucket. The bucket holds up to
+ * {@link RateLimitOptions.capacity} tokens and refills one token every
+ * {@link RateLimitOptions.interval} seconds. Each call consumes a token and runs
+ * immediately; a call made while the bucket is empty is queued and invoked as
+ * tokens refill (in call order).
+ *
+ * Unlike {@link throttle}, which drops calls that arrive within its window,
+ * `rateLimit` never drops a call — it only delays the ones that exceed the rate.
+ * A full bucket allows an initial burst of `capacity` calls.
+ *
+ * @param inner The function to invoke at the limited rate.
+ * @param options The bucket capacity (max burst) and refill interval.
+ * @return A callback that queues-and-limits invocations of `inner`, with `reset`
+ * and `dispose` handles. `dispose` cancels any queued calls and prevents further
+ * invocation.
+ */
+export function rateLimit(inner, options) {
+    const { capacity, interval } = options;
+    if (capacity < 1)
+        throw new IllegalArgumentError('capacity must be at least 1.');
+    if (interval <= 0)
+        throw new IllegalArgumentError('interval must be greater than 0.');
+    const intervalMs = interval * 1000;
+    let tokens = capacity;
+    let lastRefillMs = Date.now();
+    // The number of calls waiting for a token. Inner takes no arguments, so a
+    // count preserves call order without needing a queue of thunks.
+    let pending = 0;
+    const timeout = new TimeoutSlot();
+    let disposed = false;
+    // Credits whole tokens for the time elapsed since the last refill, capped at
+    // capacity. When the bucket is full the refill clock is synced to now so idle
+    // time can't bank tokens beyond capacity.
+    const refill = () => {
+        const now = Date.now();
+        const refilled = Math.floor((now - lastRefillMs) / intervalMs);
+        if (refilled > 0) {
+            tokens = Math.min(capacity, tokens + refilled);
+            lastRefillMs += refilled * intervalMs;
+        }
+        if (tokens === capacity)
+            lastRefillMs = now;
+    };
+    const drain = () => {
+        refill();
+        while (pending > 0 && tokens >= 1) {
+            tokens -= 1;
+            pending -= 1;
+            inner();
+        }
+        if (pending > 0 && !timeout.active) {
+            // Wait until the next whole token refills, then drain again.
+            const nextTokenMs = intervalMs - (Date.now() - lastRefillMs);
+            timeout.set(drain, nextTokenMs / 1000);
+        }
+    };
+    return Object.assign(() => {
+        if (disposed)
+            throw new DisposedError();
+        pending += 1;
+        drain();
+    }, {
+        reset() {
+            tokens = capacity;
+            lastRefillMs = Date.now();
+            if (timeout.active)
+                timeout.clear();
+            while (pending > 0) {
+                pending -= 1;
+                inner();
+            }
+        },
+        dispose() {
+            disposed = true;
+            timeout.dispose();
+        },
+    });
+}

package/dist/types/current/util/string/string.d.ts

@@ -36,6 +36,10 @@ export declare function isWhitespaceChar(charCode: number): boolean;
 export declare const predefinedDecodeEntities: ReadonlyMap<string, string>;
 /**
  * Replaces all specified entities with their mapped representations.
+ * Decimal (`&#33;`) and hexadecimal (`&#x21;`) character references are both
+ * decoded. An unrecognized named entity, or a character reference that is not a
+ * valid code point, is left as-is.
+ *
  * For example (using {@link predefinedDecodeEntities}):
  * ```
  * `&lt;Hello to y&apos;all&#33;&gt;` becomes `<Hello to y'all!>`

package/dist/types/current/util/string/string.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../../src/util/string/string.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAc5D;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CACtB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EACxC,OAAO,GAAE,MAAmC,GAC7C,MAAM,CASR;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACjC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC/C,MAAM,CAYR;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAO1D;AAID;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAM/D,CAAA;AAEF;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAC1B,GAAG,EAAE,MAAM,EACX,aAAa,GAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAA4B,GACtE,MAAM,CAeR;AAKD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASlD;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACjB,CAAC,EAAE,MAAM,GAAG,IAAI,EAChB,CAAC,EAAE,MAAM,GAAG,IAAI,EAChB,UAAU,UAAQ,GACnB,OAAO,CAOT;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,aAAa,UAAO,GACrB,MAAM,CAMR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,aAAa,UAAO,GACrB,MAAM,CAMR;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAQnD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAElE;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,EAC5C,GAAG,EAAE,CAAC,EACN,SAAS,EAAE,MAAM,EACjB,SAAS,SAAM,GAChB,CAAC,GAAG,MAAM,CAKZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQ/C"}
+{"version":3,"file":"string.d.ts","sourceRoot":"","sources":["../../../../../src/util/string/string.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,SAAS,CAAA;AACpC,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAc5D;;;;;;;;;;;;GAYG;AACH,wBAAgB,UAAU,CACtB,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC,EACxC,OAAO,GAAE,MAAmC,GAC7C,MAAM,CASR;AAED;;;;;;;GAOG;AACH,wBAAgB,qBAAqB,CACjC,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,GAC/C,MAAM,CAYR;AAED;;;;GAIG;AACH,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAO1D;AASD;;;GAGG;AACH,eAAO,MAAM,wBAAwB,EAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAM/D,CAAA;AAEF;;;;;;;;;;;;;GAaG;AACH,wBAAgB,cAAc,CAC1B,GAAG,EAAE,MAAM,EACX,aAAa,GAAE,WAAW,CAAC,MAAM,EAAE,MAAM,CAA4B,GACtE,MAAM,CAqBR;AASD;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CASlD;AAED;;;;;;GAMG;AACH,wBAAgB,KAAK,CACjB,CAAC,EAAE,MAAM,GAAG,IAAI,EAChB,CAAC,EAAE,MAAM,GAAG,IAAI,EAChB,UAAU,UAAQ,GACnB,OAAO,CAOT;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExC;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAC9B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,aAAa,UAAO,GACrB,MAAM,CAMR;AAED;;;;;;;;GAQG;AACH,wBAAgB,eAAe,CAC3B,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,MAAM,EACpB,aAAa,UAAO,GACrB,MAAM,CAMR;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAQnD;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAElE;AAED,wBAAgB,WAAW,CAAC,CAAC,SAAS,MAAM,EAAE,GAAG,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAElE;AAED;;;;;;;;;GASG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,KAAK,CAAC,MAAM,CAAC,EAC5C,GAAG,EAAE,CAAC,EACN,SAAS,EAAE,MAAM,EACjB,SAAS,SAAM,GAChB,CAAC,GAAG,MAAM,CAKZ;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQ/C"}

package/dist/types/current/util/string/string.js

@@ -68,7 +68,11 @@ export function isWhitespaceChar(charCode) {
         charCode === 0x0a //    '\n' (line feed)
     );
 }
-const encodedEntitiesRegex = /&(#(\d+)|\w+);/gi;
+const encodedEntitiesRegex = /&(?:#(?:x([\da-f]+)|(\d+))|(\w+));/gi;
+/**
+ * The highest code point representable in UTF-16.
+ */
+const MAX_CODE_POINT = 0x10ffff;
 /**
  * Predefined general xml entities
  * https://www.w3.org/TR/2008/REC-xml-20081126/#sec-predefined-ent
@@ -82,6 +86,10 @@ export const predefinedDecodeEntities = new Map([
 ]);
 /**
  * Replaces all specified entities with their mapped representations.
+ * Decimal (`!`) and hexadecimal (`!`) character references are both
+ * decoded. An unrecognized named entity, or a character reference that is not a
+ * valid code point, is left as-is.
+ *
  * For example (using {@link predefinedDecodeEntities}):
  * ```
  * `&lt;Hello to y&apos;all&#33;&gt;` becomes `<Hello to y'all!>`
@@ -91,19 +99,20 @@ export const predefinedDecodeEntities = new Map([
  * @param namedEntities
  */
 export function decodeEntities(str, namedEntities = predefinedDecodeEntities) {
-    if (encodedEntitiesRegex.test(str)) {
-        return str.replace(encodedEntitiesRegex, (substring, entityName, codePoint) => {
-            if (codePoint !== undefined)
-                return String.fromCharCode(parseInt(codePoint));
-            const entityValue = namedEntities.get(entityName.toLowerCase());
-            if (!entityValue)
-                return substring;
-            return entityValue;
-        });
-    }
-    else {
-        return str;
-    }
+    return str.replace(encodedEntitiesRegex, (substring, hex, decimal, entityName) => {
+        if (hex == null && decimal == null) {
+            return namedEntities.get(entityName.toLowerCase()) ?? substring;
+        }
+        const codePoint = hex != null ? parseInt(hex, 16) : parseInt(decimal, 10);
+        // Surrogate halves are not characters, and code points beyond the
+        // Unicode range would throw.
+        if (codePoint > MAX_CODE_POINT || isSurrogate(codePoint))
+            return substring;
+        return String.fromCodePoint(codePoint);
+    });
+}
+function isSurrogate(codePoint) {
+    return codePoint >= 0xd800 && codePoint <= 0xdfff;
 }
 const standardEntityValueToNames = flipMap(predefinedDecodeEntities);
 const entitiesRegex = /['&<>"]/g;

package/dist/types/ts3.7/index.d.ts

@@ -87,6 +87,7 @@ export * from './util/fun/debounce';
 export * from './util/fun/flow';
 export * from './util/fun/function';
 export * from './util/fun/memoize';
+export * from './util/fun/rateLimit';
 export * from './util/fun/throttle';
 export * from './util/iteration/iterable';
 export * from './util/map/map';

package/dist/types/ts3.7/util/buffer/buffer.d.ts

@@ -48,6 +48,15 @@ export declare function utf16ToUint16Array(str: string): Uint16Array;
  * @param buffer
  */
 export declare function bufferToByteArray(buffer: Uint8Array | ArrayLike<number> | ArrayBuffer): Uint8Array;
+/**
+ * Returns the bytes a buffer view spans as a standalone ArrayBuffer.
+ *
+ * Reading `buffer` from a view directly is rarely correct; it spans the whole
+ * underlying allocation, ignoring the view's `byteOffset` and `byteLength`.
+ *
+ * @param buffer An ArrayBuffer, which is returned as is, or a view to copy from.
+ */
+export declare function bufferToArrayBuffer(buffer: ArrayBufferView<ArrayBuffer> | ArrayBuffer): ArrayBuffer;
 /**
  * Returns true if the two buffers are equal.
  */

package/dist/types/ts3.7/util/collection/LruCache.d.ts

@@ -64,7 +64,8 @@ export declare class LruCache<K, V> implements CacheMap<K, V> {
      */
     delete(key: K): boolean;
     /**
-     * Executes a provided function once per each key/value pair in the Map, in insertion order.
+     * Executes a provided function once per each key/value pair in the Map,
+     * ordered from least recently used to most.
      *
      * @param callback A callback to invoke for every element in the cache.
      * @param thisArg Value to use as this when executing callback

package/dist/types/ts3.7/util/fun/rateLimit.d.ts

@@ -0,0 +1,40 @@
+import { Disposable } from '../../core/disposable';
+export interface RateLimitOptions {
+    /**
+     * The maximum number of calls that may run immediately in a burst — the
+     * token bucket's capacity. Must be at least 1.
+     */
+    readonly capacity: number;
+    /**
+     * Seconds to refill one token. In steady state the inner function runs at
+     * most once every `interval` seconds. Must be greater than 0.
+     */
+    readonly interval: number;
+}
+export interface RateLimitedCallback extends Disposable {
+    (): void;
+    /**
+     * Refills the bucket to capacity and immediately invokes any queued
+     * (delayed) calls.
+     */
+    reset(): void;
+}
+/**
+ * Rate-limits invocations with a token bucket. The bucket holds up to
+ * {@link RateLimitOptions.capacity} tokens and refills one token every
+ * {@link RateLimitOptions.interval} seconds. Each call consumes a token and runs
+ * immediately; a call made while the bucket is empty is queued and invoked as
+ * tokens refill (in call order).
+ *
+ * Unlike {@link throttle}, which drops calls that arrive within its window,
+ * `rateLimit` never drops a call — it only delays the ones that exceed the rate.
+ * A full bucket allows an initial burst of `capacity` calls.
+ *
+ * @param inner The function to invoke at the limited rate.
+ * @param options The bucket capacity (max burst) and refill interval.
+ * @return A callback that queues-and-limits invocations of `inner`, with `reset`
+ * and `dispose` handles. `dispose` cancels any queued calls and prevents further
+ * invocation.
+ */
+export declare function rateLimit(inner: () => void, options: RateLimitOptions): RateLimitedCallback;
+//# sourceMappingURL=rateLimit.d.ts.map

package/dist/types/ts3.7/util/string/string.d.ts

@@ -36,6 +36,10 @@ export declare function isWhitespaceChar(charCode: number): boolean;
 export declare const predefinedDecodeEntities: ReadonlyMap<string, string>;
 /**
  * Replaces all specified entities with their mapped representations.
+ * Decimal (`&#33;`) and hexadecimal (`&#x21;`) character references are both
+ * decoded. An unrecognized named entity, or a character reference that is not a
+ * valid code point, is left as-is.
+ *
  * For example (using {@link predefinedDecodeEntities}):
  * ```
  * `&lt;Hello to y&apos;all&#33;&gt;` becomes `<Hello to y'all!>`

package/dist/types/ts4.1/index.d.ts

@@ -87,6 +87,7 @@ export * from './util/fun/debounce';
 export * from './util/fun/flow';
 export * from './util/fun/function';
 export * from './util/fun/memoize';
+export * from './util/fun/rateLimit';
 export * from './util/fun/throttle';
 export * from './util/iteration/iterable';
 export * from './util/map/map';

package/dist/types/ts4.1/util/buffer/buffer.d.ts

@@ -48,6 +48,15 @@ export declare function utf16ToUint16Array(str: string): Uint16Array;
  * @param buffer
  */
 export declare function bufferToByteArray(buffer: Uint8Array | ArrayLike<number> | ArrayBuffer): Uint8Array;
+/**
+ * Returns the bytes a buffer view spans as a standalone ArrayBuffer.
+ *
+ * Reading `buffer` from a view directly is rarely correct; it spans the whole
+ * underlying allocation, ignoring the view's `byteOffset` and `byteLength`.
+ *
+ * @param buffer An ArrayBuffer, which is returned as is, or a view to copy from.
+ */
+export declare function bufferToArrayBuffer(buffer: ArrayBufferView<ArrayBuffer> | ArrayBuffer): ArrayBuffer;
 /**
  * Returns true if the two buffers are equal.
  */

package/dist/types/ts4.1/util/collection/LruCache.d.ts

@@ -64,7 +64,8 @@ export declare class LruCache<K, V> implements CacheMap<K, V> {
      */
     delete(key: K): boolean;
     /**
-     * Executes a provided function once per each key/value pair in the Map, in insertion order.
+     * Executes a provided function once per each key/value pair in the Map,
+     * ordered from least recently used to most.
      *
      * @param callback A callback to invoke for every element in the cache.
      * @param thisArg Value to use as this when executing callback

package/dist/types/ts4.1/util/fun/rateLimit.d.ts

@@ -0,0 +1,40 @@
+import type { Disposable } from '../../core/disposable';
+export interface RateLimitOptions {
+    /**
+     * The maximum number of calls that may run immediately in a burst — the
+     * token bucket's capacity. Must be at least 1.
+     */
+    readonly capacity: number;
+    /**
+     * Seconds to refill one token. In steady state the inner function runs at
+     * most once every `interval` seconds. Must be greater than 0.
+     */
+    readonly interval: number;
+}
+export interface RateLimitedCallback extends Disposable {
+    (): void;
+    /**
+     * Refills the bucket to capacity and immediately invokes any queued
+     * (delayed) calls.
+     */
+    reset(): void;
+}
+/**
+ * Rate-limits invocations with a token bucket. The bucket holds up to
+ * {@link RateLimitOptions.capacity} tokens and refills one token every
+ * {@link RateLimitOptions.interval} seconds. Each call consumes a token and runs
+ * immediately; a call made while the bucket is empty is queued and invoked as
+ * tokens refill (in call order).
+ *
+ * Unlike {@link throttle}, which drops calls that arrive within its window,
+ * `rateLimit` never drops a call — it only delays the ones that exceed the rate.
+ * A full bucket allows an initial burst of `capacity` calls.
+ *
+ * @param inner The function to invoke at the limited rate.
+ * @param options The bucket capacity (max burst) and refill interval.
+ * @return A callback that queues-and-limits invocations of `inner`, with `reset`
+ * and `dispose` handles. `dispose` cancels any queued calls and prevents further
+ * invocation.
+ */
+export declare function rateLimit(inner: () => void, options: RateLimitOptions): RateLimitedCallback;
+//# sourceMappingURL=rateLimit.d.ts.map

package/dist/types/ts4.1/util/string/string.d.ts

@@ -36,6 +36,10 @@ export declare function isWhitespaceChar(charCode: number): boolean;
 export declare const predefinedDecodeEntities: ReadonlyMap<string, string>;
 /**
  * Replaces all specified entities with their mapped representations.
+ * Decimal (`&#33;`) and hexadecimal (`&#x21;`) character references are both
+ * decoded. An unrecognized named entity, or a character reference that is not a
+ * valid code point, is left as-is.
+ *
  * For example (using {@link predefinedDecodeEntities}):
  * ```
  * `&lt;Hello to y&apos;all&#33;&gt;` becomes `<Hello to y'all!>`

package/dist/types/ts4.7/index.d.ts

@@ -87,6 +87,7 @@ export * from './util/fun/debounce';
 export * from './util/fun/flow';
 export * from './util/fun/function';
 export * from './util/fun/memoize';
+export * from './util/fun/rateLimit';
 export * from './util/fun/throttle';
 export * from './util/iteration/iterable';
 export * from './util/map/map';

package/dist/types/ts4.7/util/buffer/buffer.d.ts

@@ -48,6 +48,15 @@ export declare function utf16ToUint16Array(str: string): Uint16Array;
  * @param buffer
  */
 export declare function bufferToByteArray(buffer: Uint8Array | ArrayLike<number> | ArrayBuffer): Uint8Array;
+/**
+ * Returns the bytes a buffer view spans as a standalone ArrayBuffer.
+ *
+ * Reading `buffer` from a view directly is rarely correct; it spans the whole
+ * underlying allocation, ignoring the view's `byteOffset` and `byteLength`.
+ *
+ * @param buffer An ArrayBuffer, which is returned as is, or a view to copy from.
+ */
+export declare function bufferToArrayBuffer(buffer: ArrayBufferView<ArrayBuffer> | ArrayBuffer): ArrayBuffer;
 /**
  * Returns true if the two buffers are equal.
  */

package/dist/types/ts4.7/util/collection/LruCache.d.ts

@@ -67,7 +67,8 @@ export declare class LruCache<K, V> implements CacheMap<K, V> {
      */
     delete(key: K): boolean;
     /**
-     * Executes a provided function once per each key/value pair in the Map, in insertion order.
+     * Executes a provided function once per each key/value pair in the Map,
+     * ordered from least recently used to most.
      *
      * @param callback A callback to invoke for every element in the cache.
      * @param thisArg Value to use as this when executing callback

package/dist/types/ts4.7/util/fun/rateLimit.d.ts

@@ -0,0 +1,40 @@
+import type { Disposable } from '../../core/disposable';
+export interface RateLimitOptions {
+    /**
+     * The maximum number of calls that may run immediately in a burst — the
+     * token bucket's capacity. Must be at least 1.
+     */
+    readonly capacity: number;
+    /**
+     * Seconds to refill one token. In steady state the inner function runs at
+     * most once every `interval` seconds. Must be greater than 0.
+     */
+    readonly interval: number;
+}
+export interface RateLimitedCallback extends Disposable {
+    (): void;
+    /**
+     * Refills the bucket to capacity and immediately invokes any queued
+     * (delayed) calls.
+     */
+    reset(): void;
+}
+/**
+ * Rate-limits invocations with a token bucket. The bucket holds up to
+ * {@link RateLimitOptions.capacity} tokens and refills one token every
+ * {@link RateLimitOptions.interval} seconds. Each call consumes a token and runs
+ * immediately; a call made while the bucket is empty is queued and invoked as
+ * tokens refill (in call order).
+ *
+ * Unlike {@link throttle}, which drops calls that arrive within its window,
+ * `rateLimit` never drops a call — it only delays the ones that exceed the rate.
+ * A full bucket allows an initial burst of `capacity` calls.
+ *
+ * @param inner The function to invoke at the limited rate.
+ * @param options The bucket capacity (max burst) and refill interval.
+ * @return A callback that queues-and-limits invocations of `inner`, with `reset`
+ * and `dispose` handles. `dispose` cancels any queued calls and prevents further
+ * invocation.
+ */
+export declare function rateLimit(inner: () => void, options: RateLimitOptions): RateLimitedCallback;
+//# sourceMappingURL=rateLimit.d.ts.map

package/dist/types/ts4.7/util/string/string.d.ts

@@ -36,6 +36,10 @@ export declare function isWhitespaceChar(charCode: number): boolean;
 export declare const predefinedDecodeEntities: ReadonlyMap<string, string>;
 /**
  * Replaces all specified entities with their mapped representations.
+ * Decimal (`&#33;`) and hexadecimal (`&#x21;`) character references are both
+ * decoded. An unrecognized named entity, or a character reference that is not a
+ * valid code point, is left as-is.
+ *
  * For example (using {@link predefinedDecodeEntities}):
  * ```
  * `&lt;Hello to y&apos;all&#33;&gt;` becomes `<Hello to y'all!>`