Makes WP API response JSON sensible
Made with ❤ at @outlandish
Makes response JSON from the WP API sensible. By default it...
- transforms properties to camel-case
- flattens objects with a single property
rendered - lifts embedded entities (author, featured media, etc.)
- removes the
_linksproperty
See the list of effects for more.
npm install --save wp-api-response-modify// ES2015
import modify from 'wp-api-response-modify'
// CommonJS
var modify = require('wp-api-response-modify')Make a WP API response sensible.
- response {Object} Response from WP-API
- [effects] {Array} (optional) Effects to apply to the response
Returns the modified response.
All effects are available at modify.effects, e.g. modify.effects.flattenRenderedProps.
Example: featured_media => featuredMedia
Flatten any object that has a single property rendered.
Example:
{ content: { rendered: 'content string' } }
// becomes...
{ content: 'content string' }Replace the author field with the embedded author entity.
Example:
{ author: 12, _embedded: { author: { id: 12, ... } } }
// becomes...
{ author: { id: 12, ... } }Replace the featured_media field with the value of the embedded wp:featuredmedia.
Remove the _links property.
Transform all property names to camel-case in the response.
All pull requests and issues welcome!
If you're not sure how, check out Kent C. Dodds' great video tutorials on egghead.io!
wp-api-response-modify was created by Outlandish and is released under the MIT license.