A JavaScript client for HAL APIs with support for forms
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
config
demo
dist
lib
src
test
.editorconfig
.gitattributes
.gitignore
.jshintrc
.travis.yml
CONTRIBUTING.md
LICENSE
NOTICE
README.md
gulpfile.js
karma-ci.conf.js
karma.conf.js
package.json

README.md

HyperGard

Build Status

Options

applyMiddlewareStack

Allows you to pass an array of middleware function to wrap around each fetch.

Each middleware function should:

  • Have a method signature with arguments url, options, and next
  • Return the remaining stack return next(url, options) so the promise chain isn't broken

Example of Middleware for accessing calls before fetch. (Replaces beforeFetch and uniqueFetchHeaders functionality)

function setCustomHeader(url, options, next) {
  var newOptions = Object.assign({}, options, {
    headers: {
      'X-MoneyTrace': 'hey nowwwww',
    }
  });

  // Call next piece of middleware
  return next(url, newOptions);
}

Example of Middleware for accessing calls after fetch (Replaces afterFetchSuccess and afterFetchFailure functionality)

function loggerMiddleware(url, options, next) {
  // Call next piece of middleware
  var promiseChain = next(url, options);

  // Log any 401
  promiseChain.catch(function(error) {
      if (error.status === '401') {
        mockLogger.log('Unauthorized', {error: error});
      }
    })

  // Return un-caught promise chain
  return promiseChain;
}

Example of Applying middleware stack

Middleware will be called based on order of array.

hyperGard.applyMiddlewareStack([
  setCustomHeader,
  loggerMiddleware,
]);

Running Tests

Install Dependencies

$ npm run setup

Running tests to manually validate a patchset

$ npm test

Running tests during development

$ gulp test

That gulp test command will load up Chrome. Click the "Debug" button and then open the JavaScript Console to see the test results. You can also use console methods to be able to debug your tests.

Note that if you make a code change, you cannot simply reload http://localhost:8080/debug.html in Chrome. You have to stop the gulp test process with Control+C and then rerun the command (there's probably a better way to handle that, but it does the job for now).