History

Daniel Lockyer 19d2411f2b Published new versions - @tryghost/adapter-manager@0.2.27 - @tryghost/bootstrap-socket@0.2.16 - @tryghost/config-url-helpers@0.1.4 - @tryghost/constants@1.0.1 - @tryghost/database-info@0.1.0 - @tryghost/errors@1.2.1 - @tryghost/image-transform@1.0.27 - @tryghost/job-manager@0.8.18 - @tryghost/limit-service@1.0.9 - @tryghost/minifier@0.1.10 - @tryghost/moleculer-service-from-class@0.2.22 - @tryghost/mw-error-handler@0.1.2 - @tryghost/mw-session-from-token@0.1.27 - @tryghost/mw-update-user-last-seen@0.1.2 - @tryghost/package-json@1.0.15 - @tryghost/pretty-cli@1.2.23 - @tryghost/promise@0.1.14 - @tryghost/release-utils@0.7.10 - @tryghost/security@0.2.14 - @tryghost/session-service@0.1.37 - @tryghost/settings-path-manager@0.1.3 - @tryghost/vhost-middleware@1.0.20 - @tryghost/zip@1.1.19		2022-01-18 09:08:09 +00:00
..
lib	Improved error messages for loading adapters	2020-04-07 16:33:39 +02:00
test	Remove trailing commas from .eslintrc.js files	2020-08-04 14:48:07 +01:00
types	Updated type definition files	2020-05-18 15:21:44 +02: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
LICENSE	2022	2022-01-06 09:52:35 +00:00
package.json	Published new versions	2022-01-18 09:08:09 +00:00
README.md	2022	2022-01-06 09:52:35 +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