@mojaloop/inter-scheme-proxy-cache-lib

inter-scheme-proxy-cache-lib is a common component that provides proxy caching mapping. It helps reliably integrate proxy functionality throughout the all involved services.

Use cases:

• Proxy caching. (see details)
• Failure count cache with max failure count per {Id}. (see details)

Quick Start

Installation

npm install @mojaloop/inter-scheme-proxy-cache-lib

Basic Usage

// ESM
import { createProxyCache, STORAGE_TYPES } from '@mojaloop/inter-scheme-proxy-cache-lib';
// CJS
const { createProxyCache } = require('@mojaloop/inter-scheme-proxy-cache-lib');

const proxyCache = createProxyCache(STORAGE_TYPES.redis, { 
  clster: [
    { host: 'localhost', port: 6379 },
  ],
  ...
});
await proxyCache.connect();
await proxyCache.addDfspIdToProxyMapping('dfsp_1', 'proxyAB');

API docs

Check IProxyCache interface docs to get more details.

Comprehensive and interactive API documentation, based on TypeScript source code of the package, could be found here

Environment Variables

| Env Variable Name | Default Value | Description | |-----------------------------|---------------|------------------------------------| | PROXY_CACHE_LOG_LEVEL | warn | The log level for the proxyCache | | PROXY_CACHE_DEFAULT_TTL_SEC | 30 | Default cache TTL for sendToProxiesList keys |

Development

Build

Command to transpile Typescript into JS:

npm run build

Tests

npm test

Generate Typedoc documentation

npm run docs

Collaborators

• Eugen Klymniuk