@aws-amplify/cache

  • Version 5.0.5
  • Published
  • 370 kB
  • 2 dependencies
  • Apache-2.0 license

Install

npm i @aws-amplify/cache
yarn add @aws-amplify/cache
pnpm add @aws-amplify/cache

Overview

Cache category of aws-amplify

Index

Variables

variable BrowserStorageCache

const BrowserStorageCache: ICache;

    variable Cache

    const Cache: ICache;

      variable InMemoryCache

      const InMemoryCache: ICache;

        Interfaces

        interface CacheConfig

        interface CacheConfig {}
        • Cache instance options

        property Cache

        Cache?: Cache;

          property capacityInBytes

          capacityInBytes?: number;
          • Cache capacity, in bytes

          property defaultPriority

          defaultPriority?: number;
          • default priority number put on cached items

          property defaultTTL

          defaultTTL?: number;
          • Time to live, in milliseconds

          property itemMaxSize

          itemMaxSize?: number;
          • Max size of one item

          property keyPrefix

          keyPrefix?: string;
          • Prepend to key to avoid conflicts

          property storage

          storage?: Storage;

            property warningThreshold

            warningThreshold?: number;
            • Warn when over threshold percentage of capacity, maximum 1

            Package Files (4)

            Dependencies (2)

            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/@aws-amplify/cache.

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