wp-api-client     

> WordPress API client for node

Installation

$ npm i wp-api-client

Usage

``js
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
- Parameters
- fetchPosts
- Parameters
- fetchPost
- Parameters
- countPosts
- Parameters
- fetchPages
- Parameters
- fetchPage
- Parameters
- countPages
- Parameters
- Page
- Post
- Response
- Properties
- Item
- Properties

$3

Create new WordPress REST API client.

:blue_book: Documentation:

#### 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, default 10)

Returns Promise<Response<Post>> Paginated listing of posts.

#### fetchPost

Retrieve single post from target site.

##### Parameters

- id Number Unique identifier for the object.

Returns Promise<Post> Post with requested id.

#### countPosts

Count all available posts.

##### Parameters

- options Object? Endpoint arguments.

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, default 10)

Returns Promise<Response<Page>> Paginated listing of pages.

#### fetchPage

Retrieve single page from target site.

##### Parameters

- id Number Unique identifier for the object

Returns Promise<Page> Page with requested id.

#### countPages

Count all available pages.

##### Parameters

- options Object? Endpoint arguments.

Returns Number Total number of available pages.

$3

Type: Item

$3

Type: Item

$3

Type: Object

#### Properties

- total Number Total number of available items.
- totalPages Number Total number of pages.
- pageSize Number Maximum number of items returned in result set.
- items Array<T> Items returned in current result set.

$3

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.