History

Renovate Bot dee321eebc Update dependency c8 to v7.10.0		2021-10-06 23:39:01 +00:00
..
lib
test	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
types
.eslintrc.js	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
index.js
LICENSE	2021	2021-01-25 16:20:43 +00:00
package.json	Update dependency c8 to v7.10.0	2021-10-06 23:39:01 +00:00
README.md	2021	2021-01-25 16:20:43 +00:00
tsconfig.json	Stopped type declaration files from being generated	2021-07-14 11:51:14 +01:00

README.md

Adapter Manager

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

Install

npm install @tryghost/adapter-manager --save

yarn add @tryghost/adapter-manager

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();

Develop

This is a mono repository, managed with lerna.

Follow the instructions for the top-level repo.

git clone this repo & cd into it as usual
Run yarn to install top-level dependencies.

Run

yarn dev

Test

yarn lint run just eslint
yarn test run lint and tests