Skip to content

Latest commit

 

History

History
46 lines (29 loc) · 1.54 KB

CONTRIBUTING.md

File metadata and controls

46 lines (29 loc) · 1.54 KB
Raw

Development

IMPORTANT: While the library is supposed to work with Node 6 you will need to Node 8 or higher to run the tests.

Setup

npm install

Running the tests

npm run test

Running them in watch mode

npm run test -- --watch

Running the browser tests

npm run test:browser

Design Decision

The purpose of this section is to introduce contributors to the philosophy and thinking behind the architecture and API design of this library.

Isomorphic Use of the FDK

In order to allow various use-cases we want to make sure the FDK works not only in Node, but also in environments like a browser.

Client Initialization

As an alternative we could have used const gateway = new EventGateway({ options }). I suggest we avoid using the new keyword at all as if the user leaves it out this would be an issue hard to discover. In addition I suggest to go agains import FDK from 'fdk'; const fdk = new FDK() as this doesn't mention anywhere in the code that this instantiates a Event Gateway client nor does it remove the ability to extend the FDK module going forward by another client or utils.

Function Arguments

All public functions accept exactly one config argument. There are 3 major reasons why:

  1. having one object with properties allows us to extend the API easily in the future
  2. being explicit about the keys e.g. functionId or event helps developers to parse the code more easily
  3. having one argument makes it easier for functional programming in JavaScript since currying is not needed