Ghost/ghost/adapter-manager
2021-04-01 23:47:38 +00:00
..
lib
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
LICENSE 2021 2021-01-25 16:20:43 +00:00
package.json Update dependency typescript to v4.2.3 2021-04-01 23:47:38 +00:00
README.md 2021 2021-01-25 16:20:43 +00:00
tsconfig.json

Adapter Manager

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

Install

npm install @tryghost/adapter-manager --save

or

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.

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

Run

  • yarn dev

Test

  • yarn lint run just eslint
  • yarn test run lint and tests

Copyright & License

Copyright (c) 2013-2021 Ghost Foundation - Released under the MIT license.