0.0.5-beta • Published 1 year ago

wp-api-client-enhance v0.0.5-beta

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

wp api client enhance

An alternative for wp api made with TS. This is not a fork from WP api for Node. This is a new implemetation using Typescript, but inspired on it. Project currently on develop, please don't use in production.

Features

  • All the project is build with Typescript
  • Methods to make login and set custom headers
  • Inpired in Fluent API chain
  • Method to access to most importants endpoints
  • You can create a CRUD using this client

Installation

Install the package

npm install wp-api-client-enhance

Using it creating a new instance for the client

import WPApi from 'wp-api-client-enhance';

const wpApi = new WPApi(baseUrl, suffix);

Examples

Consume the API

const pages = await wpApi.pages.fetch().request();
const page = await wpApi.pages.find(1).request(); // to find a record
await wpApi.pages.find(1).update(newDataUpdated).request(); // to update a record
await wpApi.pages.find(1).delete(); // to delete a record

Always finish your instruction calling the request method.

Make a login

const loggedUsers = await wpApi.users.login({ username, password}, urlToMakeAuthRequest);

Available Collections

  • posts
  • pages
  • categories
  • comments
  • media
  • postTypes*
  • search*
  • settings*
  • tags
  • taxonomies*
  • users

*Note**: Only fetch method is available for these collections

Find a full example here

To Do

  • Upload documents to API through the package
  • Improve documentation
  • Testing

Development

Want to contribute? Great!. Open a new PR here or a new issue here