@fabrix/spool-generics

Spool - Generic API

Stats

StarsIssuesVersionUpdatedCreatedSize
@fabrix/spool-generics
411.6.02 years ago3 years agoMinified + gzip package size for @fabrix/spool-generics in KB

Readme

spool-generics

Gitter NPM version Build Status Test Coverage Dependency Status Follow @FabrixApp on Twitter

Install

$ npm install @fabrix/spool-generics --save

An adapter protocol for common functions

Generics are common features that web applications need but implement differently. The result of a Generic is a normalized way of handling these different services.

A generic is a great way to implement 3rd parties. You can write your application to implement a single service but easily swap out the the 3rd party.

Generics can add their own Models, Controllers, Services, and Policies so they can support things like vendor specific webhooks or extend functionality of Fabrix.

Current Generics: Email Provider, Payment Processors, Tax Provider, Shipping Provider, Fulfillment, Geolocation, Image Manipulation, HTML rendering, whatever you need!

Can you think of a generic or method we missed? Create a PR!

Usage

Configure

// config/main.js
module.exports = {
  // ...
  spools: [
    require('@fabrix/spool-generics').GenericsSpool
  ]
}

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.