wp-api-response-modify v3.0.0

wp-api-response-modify

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 _links property

See the list of effects for more.

Install

npm install --save wp-api-response-modify

Import

// ES2015
import modify from 'wp-api-response-modify'

// CommonJS
var modify = require('wp-api-response-modify')

Usage

modify(response[, effects]) : Object

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.

Effects

All effects are available at modify.effects, e.g. modify.effects.flattenRenderedProps.

Example: featured_media => featuredMedia

flattenRenderedProps

Flatten any object that has a single property rendered.

Example:

{ content: { rendered: 'content string' } }
// becomes...
{ content: 'content string' }

liftEmbeddedAuthor

Replace the author field with the embedded author entity.

Example:

{ author: 12, _embedded: { author: { id: 12, ... } } }
// becomes...
{ author: { id: 12, ... } }

liftEmbeddedFeaturedMedia

Replace the featured_media field with the value of the embedded wp:featuredmedia.

removeLinks

Remove the _links property.

camelize

Transform all property names to camel-case in the response.

Contributing

All pull requests and issues welcome!

If you're not sure how, check out Kent C. Dodds' great video tutorials on egghead.io!

Author & License

wp-api-response-modify was created by Outlandish and is released under the MIT license.