wp-api-client
WordPress API client for node
Installation
$ npm i wp-api-client
Usage
const WordPressClient = require('wp-api-client');
// Create API client for WordPress blog
const client = new WordPressClient('https://wordpress.org/news');
// Fetch latest post
client.fetchPosts()
.then(({ items }) => {
const { title, link } = items[0];
console.log(`"${title}": ${link}`);
});
API
Table of Contents
WordPressClient
Create new WordPress REST API client.
Parameters
-
url
String Url of WordPress installation.
fetchPosts
List posts from target site.
Parameters
-
options
Object? Endpoint arguments.-
options.pageSize
Number Maximum number of items to be returned in result set. (optional, default10
)
-
Returns Promise<Response> Paginated listing of posts.
fetchPost
Retrieve single post from target site.
Parameters
-
id
Number Unique identifier for the object.
Returns Promise<Item> Post properties in form of an Item
.
countPosts
Count all available posts.
Parameters
Returns Number Total number of available posts.
fetchPages
List pages from target site.
Parameters
-
options
Object? Endpoint arguments.-
options.pageSize
Number Maximum number of items to be returned in result set. (optional, default10
)
-
Returns Promise<Response> Paginated listing of pages.
fetchPage
Retrieve single page from target site.
Parameters
-
id
Number Unique identifier for the object
Returns Promise<Item> Page properties in form of an Item
.
countPages
Count all available pages.
Parameters
Returns Number Total number of available pages.
Item
Type: Object
Properties
-
id
Number Unique identifier for the object. -
createdAt
String Item creation date. -
modifiedAt
String Last modification date. -
link
String Url of an item. -
title
String Item's title in html format. -
excerpt
String Item's excerpt in html format. -
content
String Item's content in html format.
Response
Type: Object