1. About

CacheStorage is an open-sourced Dart library.
With CacheStorage, you can easily manage cache on your application.

Caching in CacheStorage manages value with a string key and subkeys consisting of multiple strings. The cache value can be of any type, so it can be used for various use cases.

With CacheStorage, redundant implementations of cache management are no longer necessary!

1.1. Introduction

1.1.1. Install Library

With Dart:

 dart pub add cache_storage

With Flutter:

 flutter pub add cache_storage

1.1.2. Import It

import 'package:cache_storage/cache_storage.dart';

1.1.3. Use CacheStorage

import 'package:cache_storage/cache_storage.dart';

void main() {
  // Get singleton instance of cache storage.
  final cacheStorage = CacheStorage.open();

  // You can save any objects with key.
  cacheStorage.save(
    key: 'testKey',
    value: ['spmething1', 'something2'],
  );

  // Also you can save any objects with key and sub keys.
  cacheStorage.save(
    key: 'testKey',
    subKeys: ['key1', 'key2'],
    value: 'something',
  );

  // It returns value 'something' linked to key and sub keys.
  cacheStorage.match(key: 'testKey', subKeys: ['key1', 'key2']);

  // You can delete cache by key and sub keys.
  cacheStorage.deleteBy(key: 'testKey', subKeys: ['key1', 'key2']);
  // You can delete all at the same time.
  cacheStorage.delete();

  // You can check storage has cache linked to
  // key and sub keys or not.
  if (cacheStorage.has(key: 'testKey')) {
    // Do something.
  }
}

1.2. License

Copyright (c) 2021, Kato Shinya. All rights reserved.
Use of this source code is governed by a
BSD-style license that can be found in the LICENSE file.

1.3. More Information

CacheStorage was designed and implemented by Kato Shinya.