History

Naz 37dd187fe6 Added adapter caching based on features refs https://github.com/TryGhost/Toolbox/issues/384 - Adapter cache was not able to store multiple object instances derived from same Base class. This created a need to create boilerplate "shell" classes inheriting from the Base class, e.g.: ImageSizeCacheSyncInMemory etc. - Having feature-based adapter instance caching in the adapter manager allows to simplify configuration and reuse the "base class" instead of creating artificial "shell" classes. - For example with this change both image sizes and settings caches will create separate cache instances deriving from default "Memory" class. Less code, less configuration!		2022-09-06 17:51:57 +08:00
..
lib	Added adapter caching based on features	2022-09-06 17:51:57 +08:00
test	Added adapter caching based on features	2022-09-06 17:51:57 +08:00
.eslintrc.js	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
index.js	✨ Added @tryghost/adapter-manager module (#38 )	2020-04-05 15:54:47 +02:00
package.json	Fixed full Admin test suite running during unit tests	2022-08-15 15:34:52 +02:00
README.md	Tidied up package README and LICENSE files	2022-07-26 15:22:10 +02:00

README.md

Adapter Manager

A manager for retrieving custom "adapters" - can be used to abstract away from custom implementations

Usage

const AdapterManager = require('@tryghost/adapter-manager');

const adapterManager = new AdapterManager({
    pathsToAdapters: [
        '/path/to/custom/adapters',
        '/path/to/default/adapters'
    ]
});

class MailAdapterBase {
    someMethod() {}
}

adapterManager.register('mail', MailAdapterBase);

const mailAdapterInstance = adapterManager.getAdapter('mail', 'direct', mailConfig);

mailAdapterInstance.someMethod();