@sussudio/base/common/map.d.mts

Internal APIs for VS Code's utilities and user interface building blocks.

/*---------------------------------------------------------------------------------------------
 *  Copyright (c) Microsoft Corporation. All rights reserved.
 *  Licensed under the MIT License. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

import { URI } from './uri.mjs';
export declare function getOrSet<K, V>(map: Map<K, V>, key: K, value: V): V;
export declare function mapToString<K, V>(map: Map<K, V>): string;
export declare function setToString<K>(set: Set<K>): string;
interface ResourceMapKeyFn {
	(resource: URI): string;
}
export declare class ResourceMap<T> implements Map<URI, T> {
	private static readonly defaultToKey;
	readonly [Symbol.toStringTag] = 'ResourceMap';
	private readonly map;
	private readonly toKey;
	/**
	 *
	 * @param toKey Custom uri identity function, e.g use an existing `IExtUri#getComparison`-util
	 */
	constructor(toKey?: ResourceMapKeyFn);
	/**
	 *
	 * @param other Another resource which this maps is created from
	 * @param toKey Custom uri identity function, e.g use an existing `IExtUri#getComparison`-util
	 */
	constructor(other?: ResourceMap<T>, toKey?: ResourceMapKeyFn);
	set(resource: URI, value: T): this;
	get(resource: URI): T | undefined;
	has(resource: URI): boolean;
	get size(): number;
	clear(): void;
	delete(resource: URI): boolean;
	forEach(clb: (value: T, key: URI, map: Map<URI, T>) => void, thisArg?: any): void;
	values(): IterableIterator<T>;
	keys(): IterableIterator<URI>;
	entries(): IterableIterator<[URI, T]>;
	[Symbol.iterator](): IterableIterator<[URI, T]>;
}
export declare class ResourceSet implements Set<URI> {
	readonly [Symbol.toStringTag]: string;
	private readonly _map;
	constructor(toKey?: ResourceMapKeyFn);
	constructor(entries: readonly URI[], toKey?: ResourceMapKeyFn);
	get size(): number;
	add(value: URI): this;
	clear(): void;
	delete(value: URI): boolean;
	forEach(callbackfn: (value: URI, value2: URI, set: Set<URI>) => void, thisArg?: any): void;
	has(value: URI): boolean;
	entries(): IterableIterator<[URI, URI]>;
	keys(): IterableIterator<URI>;
	values(): IterableIterator<URI>;
	[Symbol.iterator](): IterableIterator<URI>;
}
export declare const enum Touch {
	None = 0,
	AsOld = 1,
	AsNew = 2,
}
export declare class LinkedMap<K, V> implements Map<K, V> {
	readonly [Symbol.toStringTag] = 'LinkedMap';
	private _map;
	private _head;
	private _tail;
	private _size;
	private _state;
	constructor();
	clear(): void;
	isEmpty(): boolean;
	get size(): number;
	get first(): V | undefined;
	get last(): V | undefined;
	has(key: K): boolean;
	get(key: K, touch?: Touch): V | undefined;
	set(key: K, value: V, touch?: Touch): this;
	delete(key: K): boolean;
	remove(key: K): V | undefined;
	shift(): V | undefined;
	forEach(callbackfn: (value: V, key: K, map: LinkedMap<K, V>) => void, thisArg?: any): void;
	keys(): IterableIterator<K>;
	values(): IterableIterator<V>;
	entries(): IterableIterator<[K, V]>;
	[Symbol.iterator](): IterableIterator<[K, V]>;
	protected trimOld(newSize: number): void;
	private addItemFirst;
	private addItemLast;
	private removeItem;
	private touch;
	toJSON(): [K, V][];
	fromJSON(data: [K, V][]): void;
}
export declare class LRUCache<K, V> extends LinkedMap<K, V> {
	private _limit;
	private _ratio;
	constructor(limit: number, ratio?: number);
	get limit(): number;
	set limit(limit: number);
	get ratio(): number;
	set ratio(ratio: number);
	get(key: K, touch?: Touch): V | undefined;
	peek(key: K): V | undefined;
	set(key: K, value: V): this;
	private checkTrim;
}
export {};