@codingame/monaco-vscode-api 20.1.1 → 20.2.1

package/vscode/src/vs/base/common/async.d.ts

@@ -8,15 +8,50 @@ export declare function isThenable<T>(obj: unknown): obj is Promise<T>;
 export interface CancelablePromise<T> extends Promise<T> {
     cancel(): void;
 }
+/**
+ * Returns a promise that can be cancelled using the provided cancellation token.
+ *
+ * @remarks When cancellation is requested, the promise will be rejected with a {@link CancellationError}.
+ * If the promise resolves to a disposable object, it will be automatically disposed when cancellation
+ * is requested.
+ *
+ * @param callback A function that accepts a cancellation token and returns a promise
+ * @returns A promise that can be cancelled
+ */
 export declare function createCancelablePromise<T>(callback: (token: CancellationToken) => Promise<T>): CancelablePromise<T>;
+/**
+ * Returns a promise that resolves with `undefined` as soon as the passed token is cancelled.
+ * @see {@link raceCancellationError}
+ */
 export declare function raceCancellation<T>(promise: Promise<T>, token: CancellationToken): Promise<T | undefined>;
+/**
+ * Returns a promise that resolves with `defaultValue` as soon as the passed token is cancelled.
+ * @see {@link raceCancellationError}
+ */
 export declare function raceCancellation<T>(promise: Promise<T>, token: CancellationToken, defaultValue: T): Promise<T>;
+/**
+ * Returns a promise that rejects with an {@CancellationError} as soon as the passed token is cancelled.
+ * @see {@link raceCancellation}
+ */
 export declare function raceCancellationError<T>(promise: Promise<T>, token: CancellationToken): Promise<T>;
+/**
+ * Wraps a cancellable promise such that it is no cancellable. Can be used to
+ * avoid issues with shared promises that would normally be returned as
+ * cancellable to consumers.
+ */
 export declare function notCancellablePromise<T>(promise: CancelablePromise<T>): Promise<T>;
+/**
+ * Returns as soon as one of the promises resolves or rejects and cancels remaining promises
+ */
 export declare function raceCancellablePromises<T>(cancellablePromises: (CancelablePromise<T> | Promise<T>)[]): CancelablePromise<T>;
 export declare function raceTimeout<T>(promise: Promise<T>, timeout: number, onTimeout?: () => void): Promise<T | undefined>;
 export declare function raceFilter<T>(promises: Promise<T>[], filter: (result: T) => boolean): Promise<T | undefined>;
 export declare function asPromise<T>(callback: () => T | Thenable<T>): Promise<T>;
+/**
+ * Creates and returns a new promise, plus its `resolve` and `reject` callbacks.
+ *
+ * Replace with standardized [`Promise.withResolvers`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/withResolvers) once it is supported
+ */
 export declare function promiseWithResolvers<T>(): {
     promise: Promise<T>;
     resolve: (value: T | PromiseLike<T>) => void;
@@ -25,6 +60,32 @@ export declare function promiseWithResolvers<T>(): {
 export interface ITask<T> {
     (): T;
 }
+/**
+ * A helper to prevent accumulation of sequential async tasks.
+ *
+ * Imagine a mail man with the sole task of delivering letters. As soon as
+ * a letter submitted for delivery, he drives to the destination, delivers it
+ * and returns to his base. Imagine that during the trip, N more letters were submitted.
+ * When the mail man returns, he picks those N letters and delivers them all in a
+ * single trip. Even though N+1 submissions occurred, only 2 deliveries were made.
+ *
+ * The throttler implements this via the queue() method, by providing it a task
+ * factory. Following the example:
+ *
+ * 		const throttler = new Throttler();
+ * 		const letters = [];
+ *
+ * 		function deliver() {
+ * 			const lettersToDeliver = letters;
+ * 			letters = [];
+ * 			return makeTheTrip(lettersToDeliver);
+ * 		}
+ *
+ * 		function onLetterReceived(l) {
+ * 			letters.push(l);
+ * 			throttler.queue(deliver);
+ * 		}
+ */
 export declare class Throttler implements IDisposable {
     private activePromise;
     private queuedPromise;
@@ -43,6 +104,29 @@ export declare class SequencerByKey<TKey> {
     queue<T>(key: TKey, promiseTask: ITask<Promise<T>>): Promise<T>;
     keys(): IterableIterator<TKey>;
 }
+/**
+ * A helper to delay (debounce) execution of a task that is being requested often.
+ *
+ * Following the throttler, now imagine the mail man wants to optimize the number of
+ * trips proactively. The trip itself can be long, so he decides not to make the trip
+ * as soon as a letter is submitted. Instead he waits a while, in case more
+ * letters are submitted. After said waiting period, if no letters were submitted, he
+ * decides to make the trip. Imagine that N more letters were submitted after the first
+ * one, all within a short period of time between each other. Even though N+1
+ * submissions occurred, only 1 delivery was made.
+ *
+ * The delayer offers this behavior via the trigger() method, into which both the task
+ * to be executed and the waiting period (delay) must be passed in as arguments. Following
+ * the example:
+ *
+ * 		const delayer = new Delayer(WAITING_PERIOD);
+ * 		const letters = [];
+ *
+ * 		function letterReceived(l) {
+ * 			letters.push(l);
+ * 			delayer.trigger(() => { return makeTheTrip(); });
+ * 		}
+ */
 export declare class Delayer<T> implements IDisposable {
     defaultDelay: number | typeof MicrotaskDelay;
     private deferred;
@@ -57,6 +141,15 @@ export declare class Delayer<T> implements IDisposable {
     private cancelTimeout;
     dispose(): void;
 }
+/**
+ * A helper to delay execution of a task that is being requested often, while
+ * preventing accumulation of consecutive executions, while the task runs.
+ *
+ * The mail man is clever and waits for a certain amount of time, before going
+ * out to deliver letters. While the mail man is going out, more letters arrive
+ * and can only be delivered once he is back. Once he is back the mail man will
+ * do one more trip to deliver the letters that have accumulated while he was out.
+ */
 export declare class ThrottledDelayer<T> {
     private delayer;
     private throttler;
@@ -66,6 +159,9 @@ export declare class ThrottledDelayer<T> {
     cancel(): void;
     dispose(): void;
 }
+/**
+ * A barrier that is initially closed and then becomes opened permanently.
+ */
 export declare class Barrier {
     private _isOpen;
     private _promise;
@@ -75,6 +171,10 @@ export declare class Barrier {
     open(): void;
     wait(): Promise<boolean>;
 }
+/**
+ * A barrier that is initially closed and then becomes opened permanently after a certain period of
+ * time or when open is called explicitly
+ */
 export declare class AutoOpenBarrier extends Barrier {
     private readonly _timeout;
     constructor(autoOpenTimeMs: number);
@@ -82,9 +182,34 @@ export declare class AutoOpenBarrier extends Barrier {
 }
 export declare function timeout(millis: number): CancelablePromise<void>;
 export declare function timeout(millis: number, token: CancellationToken): Promise<void>;
+/**
+ * Creates a timeout that can be disposed using its returned value.
+ * @param handler The timeout handler.
+ * @param timeout An optional timeout in milliseconds.
+ * @param store An optional {@link DisposableStore} that will have the timeout disposable managed automatically.
+ *
+ * @example
+ * const store = new DisposableStore;
+ * // Call the timeout after 1000ms at which point it will be automatically
+ * // evicted from the store.
+ * const timeoutDisposable = disposableTimeout(() => {}, 1000, store);
+ *
+ * if (foo) {
+ *   // Cancel the timeout and evict it from store.
+ *   timeoutDisposable.dispose();
+ * }
+ */
 export declare function disposableTimeout(handler: () => void, timeout?: number, store?: DisposableStore): IDisposable;
+/**
+ * Runs the provided list of promise factories in sequential order. The returned
+ * promise will complete to an array of results from each promise.
+ */
 export declare function sequence<T>(promiseFactories: ITask<Promise<T>>[]): Promise<T[]>;
 export declare function first<T>(promiseFactories: ITask<Promise<T>>[], shouldStop?: (t: T) => boolean, defaultValue?: T | null): Promise<T | null>;
+/**
+ * Returns the result of the first promise that matches the "shouldStop",
+ * running all promises in parallel. Supports cancelable promises.
+ */
 export declare function firstParallel<T>(promiseList: Promise<T>[], shouldStop?: (t: T) => boolean, defaultValue?: T | null): Promise<T | null>;
 export declare function firstParallel<T, R extends T>(promiseList: Promise<T>[], shouldStop: (t: T) => t is R, defaultValue?: R | null): Promise<R | null>;
 export interface ILimiter<T> {
@@ -92,6 +217,10 @@ export interface ILimiter<T> {
     queue(factory: ITask<Promise<T>>): Promise<T>;
     clear(): void;
 }
+/**
+ * A helper to queue N promises and run them all with a max degree of parallelism. The helper
+ * ensures that at any time no more than M promises are running at the same time.
+ */
 export declare class Limiter<T> implements ILimiter<T> {
     private _size;
     private _isDisposed;
@@ -100,6 +229,11 @@ export declare class Limiter<T> implements ILimiter<T> {
     private readonly outstandingPromises;
     private readonly _onDrained;
     constructor(maxDegreeOfParalellism: number);
+    /**
+     *
+     * @returns A promise that resolved when all work is done (onDrained) or when
+     * there is nothing to do
+     */
     whenIdle(): Promise<void>;
     get onDrained(): Event<void>;
     get size(): number;
@@ -109,14 +243,29 @@ export declare class Limiter<T> implements ILimiter<T> {
     clear(): void;
     dispose(): void;
 }
+/**
+ * A queue is handles one promise at a time and guarantees that at any time only one promise is executing.
+ */
 export declare class Queue<T> extends Limiter<T> {
     constructor();
 }
+/**
+ * Same as `Queue`, ensures that only 1 task is executed at the same time. The difference to `Queue` is that
+ * there is only 1 task about to be scheduled next. As such, calling `queue` while a task is executing will
+ * replace the currently queued task until it executes.
+ *
+ * As such, the returned promise may not be from the factory that is passed in but from the next factory that
+ * is running after having called `queue`.
+ */
 export declare class LimitedQueue {
     private readonly sequentializer;
     private tasks;
     queue(factory: ITask<Promise<void>>): Promise<void>;
 }
+/**
+ * A helper to organize queues per resource. The ResourceQueue makes sure to manage queues per resource
+ * by disposing them once the queue is empty.
+ */
 export declare class ResourceQueue implements IDisposable {
     private readonly queues;
     private readonly drainers;
@@ -131,13 +280,27 @@ export declare class ResourceQueue implements IDisposable {
     dispose(): void;
 }
 export type Task<T = void> = () => (Promise<T> | T);
+/**
+ * Processes tasks in the order they were scheduled.
+*/
 export declare class TaskQueue {
     private _runningTask;
     private _pendingTasks;
+    /**
+     * Waits for the current and pending tasks to finish, then runs and awaits the given task.
+     * If the task is skipped because of clearPending, the promise is rejected with a CancellationError.
+    */
     schedule<T>(task: Task<T>): Promise<T>;
+    /**
+     * Waits for the current and pending tasks to finish, then runs and awaits the given task.
+     * If the task is skipped because of clearPending, the promise is resolved with undefined.
+    */
     scheduleSkipIfCleared<T>(task: Task<T>): Promise<T | undefined>;
     private _runIfNotRunning;
     private _processQueue;
+    /**
+     * Clears all pending tasks. Does not cancel the currently running task.
+    */
     clearPending(): void;
 }
 export declare class TimeoutTimer implements IDisposable {
@@ -163,16 +326,36 @@ export declare class RunOnceScheduler implements IDisposable {
     private timeout;
     private timeoutHandler;
     constructor(runner: (...args: any[]) => void, delay: number);
+    /**
+     * Dispose RunOnceScheduler
+     */
     dispose(): void;
+    /**
+     * Cancel current scheduled runner (if any).
+     */
     cancel(): void;
+    /**
+     * Cancel previous runner (if any) & schedule a new runner.
+     */
     schedule(delay?: number): void;
     get delay(): number;
     set delay(value: number);
+    /**
+     * Returns true if scheduled.
+     */
     isScheduled(): boolean;
     flush(): void;
     private onTimeout;
     protected doRun(): void;
 }
+/**
+ * Same as `RunOnceScheduler`, but doesn't count the time spent in sleep mode.
+ * > **NOTE**: Only offers 1s resolution.
+ *
+ * When calling `setTimeout` with 3hrs, and putting the computer immediately to sleep
+ * for 8hrs, `setTimeout` will fire **as soon as the computer wakes from sleep**. But
+ * this scheduler will execute 3hrs **after waking the computer from sleep**.
+ */
 export declare class ProcessTimeRunOnceScheduler {
     private runner;
     private timeout;
@@ -182,7 +365,13 @@ export declare class ProcessTimeRunOnceScheduler {
     constructor(runner: () => void, delay: number);
     dispose(): void;
     cancel(): void;
+    /**
+     * Cancel previous runner (if any) & schedule a new runner.
+     */
     schedule(delay?: number): void;
+    /**
+     * Returns true if scheduled.
+     */
     isScheduled(): boolean;
     private onInterval;
 }
@@ -194,11 +383,32 @@ export declare class RunOnceWorker<T> extends RunOnceScheduler {
     dispose(): void;
 }
 export interface IThrottledWorkerOptions {
+    /**
+     * maximum of units the worker will pass onto handler at once
+     */
     maxWorkChunkSize: number;
+    /**
+     * maximum of units the worker will keep in memory for processing
+     */
     maxBufferedWork: number | undefined;
+    /**
+     * delay before processing the next round of chunks when chunk size exceeds limits
+     */
     throttleDelay: number;
+    /**
+     * When enabled will guarantee that two distinct calls to `work()` are not executed
+     * without throttle delay between them.
+     * Otherwise if the worker isn't currently throttling it will execute work immediately.
+     */
     waitThrottleDelayBetweenWorkUnits?: boolean;
 }
+/**
+ * The `ThrottledWorker` will accept units of work `T`
+ * to handle. The contract is:
+ * * there is a maximum of units the worker can handle at once (via `maxWorkChunkSize`)
+ * * there is a maximum of units the worker will keep in memory for processing (via `maxBufferedWork`)
+ * * after having handled `maxWorkChunkSize` units, the worker needs to rest (via `throttleDelay`)
+ */
 export declare class ThrottledWorker<T> extends Disposable {
     private options;
     private readonly handler;
@@ -207,7 +417,20 @@ export declare class ThrottledWorker<T> extends Disposable {
     private disposed;
     private lastExecutionTime;
     constructor(options: IThrottledWorkerOptions, handler: (units: T[]) => void);
+    /**
+     * The number of work units that are pending to be processed.
+     */
     get pending(): number;
+    /**
+     * Add units to be worked on. Use `pending` to figure out
+     * how many units are not yet processed after this method
+     * was called.
+     *
+     * @returns whether the work was accepted or not. If the
+     * worker is disposed, it will not accept any more work.
+     * If the number of pending units would become larger
+     * than `maxPendingWork`, more work will also not be accepted.
+     */
     work(units: readonly T[]): boolean;
     private doWork;
     private scheduleThrottler;
@@ -218,6 +441,27 @@ export interface IdleDeadline {
     timeRemaining(): number;
 }
 type IdleApi = Pick<typeof globalThis, "requestIdleCallback" | "cancelIdleCallback">;
+/**
+ * Execute the callback the next time the browser is idle, returning an
+ * {@link IDisposable} that will cancel the callback when disposed. This wraps
+ * [requestIdleCallback] so it will fallback to [setTimeout] if the environment
+ * doesn't support it.
+ *
+ * @param callback The callback to run when idle, this includes an
+ * [IdleDeadline] that provides the time alloted for the idle callback by the
+ * browser. Not respecting this deadline will result in a degraded user
+ * experience.
+ * @param timeout A timeout at which point to queue no longer wait for an idle
+ * callback but queue it on the regular event loop (like setTimeout). Typically
+ * this should not be used.
+ *
+ * [IdleDeadline]: https://developer.mozilla.org/en-US/docs/Web/API/IdleDeadline
+ * [requestIdleCallback]: https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback
+ * [setTimeout]: https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout
+ *
+ * **Note** that there is `dom.ts#runWhenWindowIdle` which is better suited when running inside a browser
+ * context
+ */
 export declare let runWhenGlobalIdle: (callback: (idle: IdleDeadline) => void, timeout?: number) => IDisposable;
 export declare let _runWhenIdle: (targetWindow: IdleApi, callback: (idle: IdleDeadline) => void, timeout?: number) => IDisposable;
 export declare abstract class AbstractIdleValue<T> {
@@ -231,6 +475,12 @@ export declare abstract class AbstractIdleValue<T> {
     get value(): T;
     get isInitialized(): boolean;
 }
+/**
+ * An `IdleValue` that always uses the current window (which might be throttled or inactive)
+ *
+ * **Note** that there is `dom.ts#WindowIdleValue` which is better suited when running inside a browser
+ * context
+ */
 export declare class GlobalIdleValue<T> extends AbstractIdleValue<T> {
     constructor(executor: () => T);
 }
@@ -247,6 +497,9 @@ export interface ITaskSequentializerWithRunningTask {
 export interface ITaskSequentializerWithQueuedTask {
     readonly queued: IQueuedTask;
 }
+/**
+ * @deprecated use `LimitedQueue` instead for an easier to use API
+ */
 export declare class TaskSequentializer {
     private _running?;
     private _queued?;
@@ -256,10 +509,23 @@ export declare class TaskSequentializer {
     run(taskId: number, promise: Promise<void>, onCancel?: () => void): Promise<void>;
     private doneRunning;
     private runQueued;
+    /**
+     * Note: the promise to schedule as next run MUST itself call `run`.
+     *       Otherwise, this sequentializer will report `false` for `isRunning`
+     *       even when this task is running. Missing this detail means that
+     *       suddenly multiple tasks will run in parallel.
+     */
     queue(run: ITask<Promise<void>>): Promise<void>;
     hasQueued(): this is ITaskSequentializerWithQueuedTask;
     join(): Promise<void>;
 }
+/**
+ * The `IntervalCounter` allows to count the number
+ * of calls to `increment()` over a duration of
+ * `interval`. This utility can be used to conditionally
+ * throttle a frequent task when a certain threshold
+ * is reached.
+ */
 export declare class IntervalCounter {
     private readonly interval;
     private readonly nowFn;
@@ -269,6 +535,9 @@ export declare class IntervalCounter {
     increment(): number;
 }
 export type ValueCallback<T = unknown> = (value: T | Promise<T>) => void;
+/**
+ * Creates a promise whose resolution or rejection can be controlled imperatively.
+ */
 export declare class DeferredPromise<T> {
     private completeCallback;
     private errorCallback;
@@ -285,7 +554,24 @@ export declare class DeferredPromise<T> {
     cancel(): Promise<void>;
 }
 export declare namespace Promises {
+    /**
+     * A drop-in replacement for `Promise.all` with the only difference
+     * that the method awaits every promise to either fulfill or reject.
+     *
+     * Similar to `Promise.all`, only the first error will be returned
+     * if any.
+     */
     function settled<T>(promises: Promise<T>[]): Promise<T[]>;
+    /**
+     * A helper to create a new `Promise<T>` with a body that is a promise
+     * itself. By default, an error that raises from the async body will
+     * end up as a unhandled rejection, so this utility properly awaits the
+     * body and rejects the promise as a normal promise does without async
+     * body.
+     *
+     * This method should only be used in rare cases where otherwise `async`
+     * cannot be used (e.g. when callbacks are involved that require this).
+     */
     function withAsyncBody<T, E = Error>(bodyFn: (resolve: (value: T) => unknown, reject: (error: E) => unknown) => Promise<unknown>): Promise<T>;
 }
 export declare class StatefulPromise<T> {
@@ -297,24 +583,67 @@ export declare class StatefulPromise<T> {
     get isResolved(): boolean;
     readonly promise: Promise<T>;
     constructor(promise: Promise<T>);
+    /**
+     * Returns the resolved value.
+     * Throws if the promise is not resolved yet.
+     */
     requireValue(): T;
 }
 export declare class LazyStatefulPromise<T> {
     private readonly _compute;
     private readonly _promise;
     constructor(_compute: () => Promise<T>);
+    /**
+     * Returns the resolved value.
+     * Throws if the promise is not resolved yet.
+     */
     requireValue(): T;
+    /**
+     * Returns the promise (and triggers a computation of the promise if not yet done so).
+     */
     getPromise(): Promise<T>;
+    /**
+     * Reads the current value without triggering a computation of the promise.
+     */
     get currentValue(): T | undefined;
 }
+/**
+ * An object that allows to emit async values asynchronously or bring the iterable to an error state using `reject()`.
+ * This emitter is valid only for the duration of the executor (until the promise returned by the executor settles).
+ */
 export interface AsyncIterableEmitter<T> {
+    /**
+     * The value will be appended at the end.
+     *
+     * **NOTE** If `reject()` has already been called, this method has no effect.
+     */
     emitOne(value: T): void;
+    /**
+     * The values will be appended at the end.
+     *
+     * **NOTE** If `reject()` has already been called, this method has no effect.
+     */
     emitMany(values: T[]): void;
+    /**
+     * Writing an error will permanently invalidate this iterable.
+     * The current users will receive an error thrown, as will all future users.
+     *
+     * **NOTE** If `reject()` have already been called, this method has no effect.
+     */
     reject(error: Error): void;
 }
+/**
+ * An executor for the `AsyncIterableObject` that has access to an emitter.
+ */
 export interface AsyncIterableExecutor<T> {
+    /**
+     * @param emitter An object that allows to emit async values valid only for the duration of the executor.
+     */
     (emitter: AsyncIterableEmitter<T>): unknown | Promise<unknown>;
 }
+/**
+ * A rich implementation for an `AsyncIterable<T>`.
+ */
 export declare class AsyncIterableObject<T> implements AsyncIterable<T> {
     static fromArray<T>(items: T[]): AsyncIterableObject<T>;
     static fromPromise<T>(promise: Promise<T[]>): AsyncIterableObject<T>;
@@ -337,9 +666,31 @@ export declare class AsyncIterableObject<T> implements AsyncIterable<T> {
     coalesce(): AsyncIterableObject<NonNullable<T>>;
     static toPromise<T>(iterable: AsyncIterable<T>): Promise<T[]>;
     toPromise(): Promise<T[]>;
+    /**
+     * The value will be appended at the end.
+     *
+     * **NOTE** If `resolve()` or `reject()` have already been called, this method has no effect.
+     */
     private emitOne;
+    /**
+     * The values will be appended at the end.
+     *
+     * **NOTE** If `resolve()` or `reject()` have already been called, this method has no effect.
+     */
     private emitMany;
+    /**
+     * Calling `resolve()` will mark the result array as complete.
+     *
+     * **NOTE** `resolve()` must be called, otherwise all consumers of this iterable will hang indefinitely, similar to a non-resolved promise.
+     * **NOTE** If `resolve()` or `reject()` have already been called, this method has no effect.
+     */
     private resolve;
+    /**
+     * Writing an error will permanently invalidate this iterable.
+     * The current users will receive an error thrown, as will all future users.
+     *
+     * **NOTE** If `resolve()` or `reject()` have already been called, this method has no effect.
+     */
     private reject;
 }
 export declare class CancelableAsyncIterableObject<T> extends AsyncIterableObject<T> {
@@ -354,6 +705,12 @@ export declare class AsyncIterableSource<T> {
     private _errorFn;
     private _emitOneFn;
     private _emitManyFn;
+    /**
+     *
+     * @param onReturn A function that will be called when consuming the async iterable
+     * has finished by the consumer, e.g the for-await-loop has be existed (break, return) early.
+     * This is NOT called when resolving this source by its owner.
+     */
     constructor(onReturn?: () => Promise<void> | void);
     get asyncIterable(): AsyncIterableObject<T>;
     resolve(): void;
@@ -362,6 +719,10 @@ export declare class AsyncIterableSource<T> {
     emitMany(items: T[]): void;
 }
 export declare function cancellableIterable<T>(iterableOrIterator: AsyncIterator<T> | AsyncIterable<T>, token: CancellationToken): AsyncIterableIterator<T>;
+/**
+ * Important difference to AsyncIterableObject:
+ * If it is iterated two times, the second iterator will not see the values emitted by the first iterator.
+ */
 export declare class AsyncIterableProducer<T> implements AsyncIterable<T> {
     private readonly _onReturn?;
     private readonly _producerConsumer;

package/vscode/src/vs/base/common/buffer.d.ts

@@ -1,16 +1,41 @@
 import * as streams from "./stream.js";
 export declare class VSBuffer {
+    /**
+     * When running in a nodejs context, the backing store for the returned `VSBuffer` instance
+     * might use a nodejs Buffer allocated from node's Buffer pool, which is not transferrable.
+     */
     static alloc(byteLength: number): VSBuffer;
+    /**
+     * When running in a nodejs context, if `actual` is not a nodejs Buffer, the backing store for
+     * the returned `VSBuffer` instance might use a nodejs Buffer allocated from node's Buffer pool,
+     * which is not transferrable.
+     */
     static wrap(actual: Uint8Array): VSBuffer;
+    /**
+     * When running in a nodejs context, the backing store for the returned `VSBuffer` instance
+     * might use a nodejs Buffer allocated from node's Buffer pool, which is not transferrable.
+     */
     static fromString(source: string, options?: {
         dontUseNodeBuffer?: boolean;
     }): VSBuffer;
+    /**
+     * When running in a nodejs context, the backing store for the returned `VSBuffer` instance
+     * might use a nodejs Buffer allocated from node's Buffer pool, which is not transferrable.
+     */
     static fromByteArray(source: number[]): VSBuffer;
+    /**
+     * When running in a nodejs context, the backing store for the returned `VSBuffer` instance
+     * might use a nodejs Buffer allocated from node's Buffer pool, which is not transferrable.
+     */
     static concat(buffers: VSBuffer[], totalLength?: number): VSBuffer;
     static isNativeBuffer(buffer: unknown): boolean;
     readonly buffer: Uint8Array;
     readonly byteLength: number;
     private constructor();
+    /**
+     * When running in a nodejs context, the backing store for the returned `VSBuffer` instance
+     * might use a nodejs Buffer allocated from node's Buffer pool, which is not transferrable.
+     */
     clone(): VSBuffer;
     toString(): string;
     slice(start?: number, end?: number): VSBuffer;
@@ -28,6 +53,10 @@ export declare class VSBuffer {
     indexOf(subarray: VSBuffer | Uint8Array, offset?: number): number;
     equals(other: VSBuffer): boolean;
 }
+/**
+ * Like String.indexOf, but works on Uint8Arrays.
+ * Uses the boyer-moore-horspool algorithm to be reasonably speedy.
+ */
 export declare function binaryIndexOf(haystack: Uint8Array, needle: Uint8Array, offset?: number): number;
 export declare function readUInt16LE(source: Uint8Array, offset: number): number;
 export declare function writeUInt16LE(destination: Uint8Array, value: number, offset: number): void;
@@ -54,7 +83,9 @@ export declare function streamToBufferReadableStream(stream: streams.ReadableStr
 export declare function newWriteableBufferStream(options?: streams.WriteableStreamOptions): streams.WriteableStream<VSBuffer>;
 export declare function prefixedBufferReadable(prefix: VSBuffer, readable: VSBufferReadable): VSBufferReadable;
 export declare function prefixedBufferStream(prefix: VSBuffer, stream: VSBufferReadableStream): VSBufferReadableStream;
+/** Decodes base64 to a uint8 array. URL-encoded and unpadded base64 is allowed. */
 export declare function decodeBase64(encoded: string): VSBuffer;
+/** Encodes a buffer to a base64 string. */
 export declare function encodeBase64({ buffer }: VSBuffer, padded?: boolean, urlSafe?: boolean): string;
 export declare function encodeHex({ buffer }: VSBuffer): string;
 export declare function decodeHex(hex: string): VSBuffer;

package/vscode/src/vs/base/common/cache.d.ts

@@ -11,8 +11,16 @@ export declare class Cache<T> {
 }
 export declare function identity<T>(t: T): T;
 interface ICacheOptions<TArg> {
+    /**
+     * The cache key is used to identify the cache entry.
+     * Strict equality is used to compare cache keys.
+    */
     getCacheKey: (arg: TArg) => unknown;
 }
+/**
+ * Uses a LRU cache to make a given parametrized function cached.
+ * Caches just the last key/value.
+*/
 export declare class LRUCachedFunction<TArg, TComputed> {
     private lastCache;
     private lastArgKey;
@@ -22,6 +30,9 @@ export declare class LRUCachedFunction<TArg, TComputed> {
     constructor(options: ICacheOptions<TArg>, fn: (arg: TArg) => TComputed);
     get(arg: TArg): TComputed;
 }
+/**
+ * Uses an unbounded cache to memoize the results of the given function.
+*/
 export declare class CachedFunction<TArg, TComputed> {
     private readonly _map;
     private readonly _map2;