@coffeekraken/s-builder

@coffeekraken/s-builder

MIT 2.0.0-alpha.20 - Git repository

Base class to create builders on top of like the @coffeekraken/s-images-builder, etc...

Install

npm i @coffeekraken/s-builder

SBuilder

This package expose a simple SBuilder class that is meant to be extended for each builder you want to create.

For now, this class is the main one used in builders like:

• @coffeekraken/s-favicon-builder
• @coffeekraken/s-images-builder
• @coffeekraken/s-markdown-builder
• @coffeekraken/s-postcss-builder
• @coffeekraken/s-sitemap-builder
• @coffeekraken/s-static-builder
• @coffeekraken/s-typescript-builder

Features

This simple base class gives you some features like:

• Specify a @coffeekraken/s-interface interface
• Expose a build method that accepts a params object which reflect your interface
• Let you define a _build method that will be called with your resolved params object

Usage

Here's a simple example of a custom builder:

import SBuilder from '@coffeekraken/s-builder';
import SPromise from '@coffeekraken/s-promise';
class MyBuilder extends SBuilder {
  constructor(settings = {}) {
    super(settings);
  }
  _build(params, settings) {
    return new SPromise(({ resolve, reject, emit }) => {
      // compilation logic
    });
  }
}

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Here's all the ways you can contact us listed: