[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/js/dist/ -> api-fetch.js (summary)

(no description)

File Size: 784 lines (22 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 8 functions

  createNonceMiddleware()
  createPreloadingMiddleware()
  prepareResponse()
  parseAndThrowError()
  isMediaUploadRequest()
  registerMiddleware()
  setFetchHandler()
  apiFetch()

Functions
Functions that are not part of a class:

createNonceMiddleware(nonce)   X-Ref

param: {string} nonce
return: {import('../types').APIFetchMiddleware & { nonce: string }} A middleware to enhance a request with a nonce.

createPreloadingMiddleware(preloadedData)   X-Ref

param: {Record<string, any>} preloadedData
return: {import('../types').APIFetchMiddleware} Preloading middleware.

prepareResponse(responseData, parse)   X-Ref
This is a helper function that sends a success response.

param: {Record<string, any>} responseData
param: {boolean}             parse
return: {Promise<any>} Promise with the response.

parseAndThrowError(response)   X-Ref
Parses a response, throwing an error if parsing the response fails.

param: {Response} response
param: {boolean}  shouldParseResponse
return: {Promise<any>} Parsed response.

isMediaUploadRequest(options)   X-Ref

param: {import('../types').APIFetchOptions} options
return: {boolean} True if the request is for media upload.

registerMiddleware(middleware)   X-Ref
Register a middleware

param: {import('./types').APIFetchMiddleware} middleware

setFetchHandler(newFetchHandler)   X-Ref
Defines a custom fetch handler for making the requests that will override
the default one using window.fetch

param: {FetchHandler} newFetchHandler The new fetch handler

apiFetch(options)   X-Ref

param: {import('./types').APIFetchOptions} options
return: {Promise<T>} A promise representing the request processed via the registered middlewares.



Generated: Wed May 25 01:00:02 2022 Cross-referenced by PHPXref 0.7.1