Skip to content

limistah/redux-api-middleware-broker

master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 

redux-api-middleware-broker

Have you seen the docs for Redux API Middleware?

You very sure must love the concept of the library creator, right? 😄😄😄

Did you notice how to construct a basic action? 😞😞😞

Have you tried uploading a file with an action but could not find it to work? 😞😞😞

You wanted more from the middleware but don't have to look through the docs every now and then? 😞😞😞

Solution? 😏😏😏

Well, you can ride on this broker. 🚀🚀🚀 It interacts between you and a few of JS lines to produce an action that redux-api-middleware understands.

You can go way basic like this to ask for an action to be created for GET /users:

import reduxApiMiddlewareBroker from "redux-api-middleware-broker";

const action = reduxApiMiddlewareBroker({
  types: [MAIN_ACTION_TYPE, SUCCESS_ACTION_TYPE, ERROR_ACTION_TYPE],
  method: "GET",
  endpoint: `/users`
});


// const action = {
//   "@@redux-api-middleware/RSAA": {
//     endpoint: "/users",
//     method: "GET",
//     types: [
//       "MAIN_ACTION_TYPE",
//       { type: "SUCCESS_ACTION_TYPE" },
//       { type: "ERROR_ACTION_TYPE" }
//     ],
//     headers: {}
//   }
// };

dispatch(action);

So.... you don't have to keep doing:

const { RSAA } = require("redux-api-middleware");

And likes...

Docs

This module exports a function that can be called as the only and default export.

And should be called fully as follows

import reduxApiMiddlewareBroker from "redux-api-middleware-broker";

// Build the action using the broker shorthand 💪💪💪💪
const action = reduxApiMiddlewareBroker(
  options,
  isFileUpload,
  onRequestComplete,
  preprocessResult
);

// Dispatch the built Redux API Middleware compatible action.
// Hurray!!! 💃💃💃💃
dispatch(action);

Parameters

options: object

The basic required options to pass for the actions to get created.

Below can be set on the options:

  • endpoint: string: The request endpoint to call
  • types: array: As explained by redux-api-middleware, same format is requested here.
  • method: string: HTTP method to issue the request with
  • body: object: HTTP request body to send to the request url
  • headers: object: HTTP request headers be sent with the request
  • credentials: string: Whether or not to send cookies with the API call. Must be one of omit, same-origin, include.
  • fetch: function: A custom Fetch implementation.
  • options: object: The fetch options for the API call.
import reduxApiMiddlewareBroker from "redux-api-middleware-broker";

const action = reduxApiMiddlewareBroker({
  types: [MAIN_ACTION_TYPE, SUCCESS_ACTION_TYPE, ERROR_ACTION_TYPE],
  method: "POST",
  endpoint: `/users`,
  body: { name: "Aleem Isiaka", country: "Nigeria", state: "Lagos" }
});

dispatch(action);

isFileUpload: boolean

Default: false

To determine if the request is a file upload. This is required for proper file upload handling.

A call to a file upload endpoint without this would fail.

const action = reduxApiMiddlewareBroker(
  {
    types: [MAIN_ACTION_TYPE, SUCCESS_ACTION_TYPE, ERROR_ACTION_TYPE],
    method: "POST",
    endpoint: `/files`,
    body: file // file to be uplaoded here
  },
  true
);

onRequestComplete: function

Default: () => {}

A notifier or similar. You can set cache, clear cache etc using this function.

It receives the following params:

  • action => The action that triggered the request
  • state => The previous state of the reducer
  • response => XHR response object
const action = reduxApiMiddlewareBroker(
  {
    types: [MAIN_ACTION_TYPE, SUCCESS_ACTION_TYPE, ERROR_ACTION_TYPE],
    method: "GET",
    endpoint: `/users`
  },
  false,
  (action, state, response) => console.log({ action, state, response })
);

preprocessResult: function

Default: json => json

A function to preprocess the received result after a successful request.

The function receives a JSON, and expects JSON to be returned as well.

const action = reduxApiMiddlewareBroker(
  {
    types: [MAIN_ACTION_TYPE, SUCCESS_ACTION_TYPE, ERROR_ACTION_TYPE],
    method: "GET",
    endpoint: `/users`
  },
  false,
  () => {},
  json => {
    json.date = Date.now();
    return json;
  }
);

License

MIT

About

Broker for creating an understandable action contract for redux-api-middleware

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published