@types/file-entry-cache 5.0.3 → 10.0.0

file-entry-cache/README.md

@@ -1,15 +1,3 @@
-# Installation
-> `npm install --save @types/file-entry-cache`
-
-# Summary
-This package contains type definitions for file-entry-cache (https://github.com/royriojas/file-entry-cache#readme).
-
-# Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/file-entry-cache.
-
-### Additional Details
- * Last updated: Wed, 18 Oct 2023 01:17:34 GMT
- * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
-
-# Credits
-These definitions were written by [Piotr Błażejewicz](https://github.com/peterblazejewicz).
+This is a stub types definition for @types/file-entry-cache (https://github.com/jaredwray/cacheable#readme).
+
+file-entry-cache provides its own type definitions, so you don't need @types/file-entry-cache installed!

file-entry-cache/package.json

@@ -1,27 +1,12 @@
 {
     "name": "@types/file-entry-cache",
-    "version": "5.0.3",
-    "description": "TypeScript definitions for file-entry-cache",
-    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/file-entry-cache",
-    "license": "MIT",
-    "contributors": [
-        {
-            "name": "Piotr Błażejewicz",
-            "githubUsername": "peterblazejewicz",
-            "url": "https://github.com/peterblazejewicz"
-        }
-    ],
+    "version": "10.0.0",
+    "description": "Stub TypeScript definitions entry for file-entry-cache, which provides its own types definitions",
     "main": "",
-    "types": "index.d.ts",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
-        "directory": "types/file-entry-cache"
-    },
     "scripts": {},
+    "license": "MIT",
     "dependencies": {
-        "@types/node": "*"
+        "file-entry-cache": "*"
     },
-    "typesPublisherContentHash": "cc490c6c11597c61699fd1446621e94c0e802abaaca3135d58d3405555b21038",
-    "typeScriptVersion": "4.5"
+    "deprecated": "This is a stub types definition. file-entry-cache provides its own type definitions, so you do not need this installed."
 }

file-entry-cache/index.d.ts

@@ -1,78 +0,0 @@
-/// <reference types="node" />
-
-/**
- * @param pathToCache - the path to the cache file (this combines the cache name and directory
- * @param useCheckSum - Whether to use md5 checksum to verify if file changed.
- * If false the default will be to use the mtime and size of the file
- */
-export function createFromFile(pathToCache: string, useCheckSum?: boolean): FileEntryCache;
-
-/**
- * @param cacheName - the name of the cache to be created
- * @param directory - the directory to load the cache from
- * @param usecheckSum - Whether to use md5 checksum to verify if file changed.
- * If false the default will be to use the mtime and size of the file
- */
-export function create(cacheName: string, directory?: string, usecheckSum?: boolean): FileEntryCache;
-
-export interface FileEntryCache {
-    /** the flat cache storage used to persist the metadata of the `files */
-    cache: object;
-    /** Given a buffer, calculate md5 hash of its content. */
-    getHash(buffer: Buffer): string;
-    /**  Return whether or not a file has changed since last time reconcile was called */
-    hasFileChanged(file: string): boolean;
-    /**
-     * given an array of file paths it return and object with three arrays:
-     *  - changedFiles: Files that changed since previous run
-     *  - notChangedFiles: Files that haven't change
-     *  - notFoundFiles: Files that were not found, probably deleted
-     */
-    analyzeFiles(files?: string[]): AnalyzedFilesInfo;
-    getFileDescriptor(file: string): FileDescriptor;
-    /**
-     * Return the list o the files that changed compared
-     * against the ones stored in the cache
-     */
-    getUpdatedFiles(files?: string[]): string[];
-    /**
-     * return the list of file
-     */
-    normalizeEntries(files?: string[]): FileDescriptor[];
-    /**
-     * Remove an entry from the file-entry-cache.
-     * Useful to force the file to still be considered
-     * modified the next time the process is run
-     */
-    removeEntry(entryName: string): void;
-    /**
-     * Delete the cache file from the disk
-     */
-    deleteCacheFile(): void;
-    /**
-     * remove the cache from the file and clear the memory cache
-     */
-    destroy(): void;
-    /**
-     * Sync the files and persist them to the cache
-     */
-    reconcile(noPrune?: boolean): void;
-}
-
-export interface AnalyzedFilesInfo {
-    readonly changedFiles: string[];
-    readonly notFoundFiles: string[];
-    readonly notChangedFiles: string[];
-}
-
-export interface FileDescriptor {
-    readonly key: string;
-    readonly notFound: boolean;
-    readonly err?: Error | undefined;
-    readonly changed?: boolean | undefined;
-    readonly meta?: {
-        readonly size?: number | undefined;
-        readonly mtime?: number | undefined;
-        readonly hash?: string | undefined;
-    } | undefined;
-}