File size: 2,320 Bytes
1e92f2d |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
import { WPCOM_HTTP_REQUEST } from 'calypso/state/action-types';
/**
* @typedef {Object} RequestDescription
* @property {string} [apiVersion] specific API version for request
* @property {string} [apiNamespace] specific API namespace for request (preferred over version)
* @property {Object} [body] JSON-serializable body for POST requests
* @property {string} method name of HTTP method to use
* @property {string} path WordPress.com API path with %s and %d placeholders, e.g. /sites/%s
* @property {Object} [query] key/value pairs for query string
* @property {FormData} [formData] key/value pairs for POST body, encoded as "multipart/form-data"
* @property {Object} [onSuccess] Redux action to call when request succeeds
* @property {Object} [onFailure] Redux action to call when request fails
* @property {Object} [onProgress] Redux action to call on progress events from an upload
* @property {Object} [onStreamRecord] callback for each record of a streamed response
* @property {Object} [retryPolicy] how to handle retries on request failure
* @property {Object} [options] extra options to send to the middleware, e.g. retry policy or offline policy
*/
/**
* Returns a valid WordPress.com API HTTP Request action object
* @param {RequestDescription} HTTP request description
* @param {?Object} action default action to call on HTTP events
* @returns {import('redux').Action} Redux action describing WordPress.com API HTTP request
*/
export const http = (
{
apiVersion,
apiNamespace,
body,
method,
path,
query = {},
formData,
onSuccess,
onFailure,
onProgress,
onStreamRecord,
...options
},
action = null
) => {
const version = apiNamespace ? { apiNamespace } : { apiVersion };
if ( process.env.NODE_ENV === 'development' ) {
if ( ! ( action || onSuccess ) ) {
// eslint-disable-next-line no-console
console.warn(
'No success handler or default action supplied to the http action. You probably want one or the other. Path: %s',
path
);
}
}
return {
type: WPCOM_HTTP_REQUEST,
body,
method,
path,
query: { ...query, ...version },
formData,
onSuccess: onSuccess || action,
onFailure: onFailure || action,
onProgress: onProgress || action,
onStreamRecord: onStreamRecord || action,
options,
};
};
|