https://github.com/vladimyr/wp-api-client
WordPress API client for node
https://github.com/vladimyr/wp-api-client
nodejs wordpress wordpress-rest-api
Last synced: 4 months ago
JSON representation
WordPress API client for node
- Host: GitHub
- URL: https://github.com/vladimyr/wp-api-client
- Owner: vladimyr
- License: mit
- Created: 2018-11-22T21:42:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2018-11-24T19:53:03.000Z (over 6 years ago)
- Last Synced: 2024-04-27T03:02:40.399Z (about 1 year ago)
- Topics: nodejs, wordpress, wordpress-rest-api
- Language: JavaScript
- Homepage:
- Size: 200 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wp-api-client [](https://travis-ci.com/vladimyr/wp-api-client) [](https://packagephobia.now.sh/result?p=wp-api-client) [](https://npm.im/wp-api-client) [](https://github.com/vladimyr/wp-api-client/blob/master/LICENSE) [](https://github.com/Flet/semistandard)
> 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](#wordpressclient)
- [Parameters](#parameters)
- [fetchPosts](#fetchposts)
- [Parameters](#parameters-1)
- [fetchPost](#fetchpost)
- [Parameters](#parameters-2)
- [countPosts](#countposts)
- [Parameters](#parameters-3)
- [fetchPages](#fetchpages)
- [Parameters](#parameters-4)
- [fetchPage](#fetchpage)
- [Parameters](#parameters-5)
- [countPages](#countpages)
- [Parameters](#parameters-6)
- [Page](#page)
- [Post](#post)
- [Response](#response)
- [Properties](#properties)
- [Item](#item)
- [Properties](#properties-1)
### WordPressClient
Create new WordPress REST API client.
:blue_book: Documentation:
#### Parameters
- `url` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Url of WordPress installation.
#### fetchPosts
List posts from target site.
##### Parameters
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/posts/#arguments).
- `options.pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items to be returned in result set. (optional, default `10`)
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Response](#response)<[Post](#post)>>** Paginated listing of posts.
#### fetchPost
Retrieve single post from target site.
##### Parameters
- `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object.
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Post](#post)>** `Post` with requested `id`.
#### countPosts
Count all available posts.
##### Parameters
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/posts/#arguments).
Returns **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available posts.
#### fetchPages
List pages from target site.
##### Parameters
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/pages/#arguments).
- `options.pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items to be returned in result set. (optional, default `10`)
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Response](#response)<[Page](#page)>>** Paginated listing of pages.
#### fetchPage
Retrieve single page from target site.
##### Parameters
- `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Page](#page)>** `Page` with requested `id`.
#### countPages
Count all available pages.
##### Parameters
- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)?** Endpoint [arguments](https://developer.wordpress.org/rest-api/reference/pages/#arguments).
Returns **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available pages.
### Page
Type: [Item](#item)
### Post
Type: [Item](#item)
### Response
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
#### Properties
- `total` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of available items.
- `totalPages` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Total number of pages.
- `pageSize` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Maximum number of items returned in result set.
- `items` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<T>** Items returned in current result set.
### Item
Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
#### Properties
- `id` **[Number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Unique identifier for the object.
- `createdAt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item creation date.
- `modifiedAt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Last modification date.
- `link` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Url of an item.
- `title` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's title in html format.
- `excerpt` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's excerpt in html format.
- `content` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Item's content in html format.