lib/dispatcher/APIDispatcher.js

"use strict";

import Flux from "flux";

const { Dispatcher } = Flux;

/**
 * A generic action object that is dispatched by {APIDispatcher}
 *
 * @typedef {object} Action
 * @property {string} actionType - The type of action being dispatched
 */

/**
 * An action object that is dispatched when items should be added to a store
 *
 * @typedef {object} MergeAction
 * @property {string} actionType - The type of action being dispatched
 * @property {Array<object>} items - An array of items to be added to the store
 */

/**
 * An action object that is dispatched when counts should be added to a store
 *
 * @typedef {object} CountAction
 * @property {string} actionType - The type of action being dispatched
 * @property {number} count - The count returned from the API call
 * @property {ResourceQuery} [query] - The query params for the count call
 */

/**
 * An action object the is dispatched when an object is destroyed
 *
 * @typedef {object} DestroyAction
 * @property {string} actionType - The type of action being dispatched
 * @property {number|string} id - The id of the destroyed resource
 */

export default new Dispatcher();