refui/src/extras/cache.d.ts

The JavaScript framework that refuels your UI projects, across web, native, and embedded

/* Copyright Yukino Song, SudoMaker Ltd.
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 * 	http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

import type { Component, ComponentTemplate } from '../components.js'

export interface CacheExpose {
	cache: WeakMap<Component<any>, unknown>
}

export interface CacheStore<T = any> {
	getIndex(handler: (item: T) => boolean): number
	add(...items: T[]): void
	replace(items: T[]): void
	get(index: number): T | undefined
	set(index: number, item: T): void
	del(index: number): void
	clear(): void
	size(): number
	dispose(): void
	Cached: ComponentTemplate<{ expose?: (api: CacheExpose) => void }>
}

export function createCache<T = any>(template: ComponentTemplate<T>): CacheStore<T>