@soluble/cache-interop

Async cache interop contracts

Usage no npm install needed!

<script type="module">
  import solubleCacheInterop from 'https://cdn.skypack.dev/@soluble/cache-interop';
</script>

README

@soluble/cache-interop

Interoperability cache contracts and utilities.

Codecov Downloads Size Codecov Codefactor CodeClimate TechDebt Typings Licence

About | Documentation

Package holding cache-interop contracts. You may want to look for official adapter implementations instead.

Install

$ yarn add @soluble/cache-interop

Interfaces

CacheInterface

import { CacheInterface, ConnectedCacheInterface } from '@soluble/cache-interop';

class MyCache implements CacheInterface, ConnectedCacheInterface {
  //...
}

Utilities

Guards

Typescript typeguards

import { Guards } from '@soluble/cache-interop';

if (Guards.isConnectedCache(cache)) {
  await cache.getConnection().quit();
}

Guards.isValidCacheKey(key);

Guards.isCacheValueProviderFn(async () => {});

Guards.isNonEmptyString('Hi!');

Asserts

Typescript assertions

import { Asserts } from '@soluble/cache-interop';

Asserts.assertValidCacheKey(key);