@types/flat-cache

  • Version 2.0.0
  • Published
  • 3.32 kB
  • No dependencies
  • MIT license

Install

npm i @types/flat-cache
yarn add @types/flat-cache
pnpm add @types/flat-cache

Overview

TypeScript definitions for flat-cache

Index

Functions

function clearAll

clearAll: (cacheDir?: string) => boolean;

    function clearCacheById

    clearCacheById: (cacheId: string, cacheDir?: string) => boolean;

      function create

      create: (cacheId: string, cacheDir?: string) => Cache;

        function createFromFile

        createFromFile: (filePath: string) => Cache;

          function load

          load: (cacheId: string, cacheDir?: string) => Cache;

            Interfaces

            interface Cache

            interface Cache {}

              method all

              all: () => { [key: string]: any };

                method destroy

                destroy: () => void;

                  method getKey

                  getKey: (key: string) => any;

                    method keys

                    keys: () => string[];

                      method load

                      load: (cacheId: string, cacheDir?: string) => void;

                        method loadFile

                        loadFile: (pathToFile: string) => void;

                          method removeCacheFile

                          removeCacheFile: () => boolean;

                            method removeKey

                            removeKey: (key: string) => void;

                              method save

                              save: (noPrune?: boolean) => void;

                                method setKey

                                setKey: (key: string, value: any) => void;

                                  Package Files (1)

                                  Dependencies (0)

                                  No dependencies.

                                  Dev Dependencies (0)

                                  No dev dependencies.

                                  Peer Dependencies (0)

                                  No peer dependencies.

                                  Badge

                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/flat-cache.

                                  • Markdown
                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/flat-cache)
                                  • HTML
                                    <a href="https://www.jsdocs.io/package/@types/flat-cache"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>