Skip to content

Get all your public wordpress data through the WP API using a tree-shakable typescript library.

License

Notifications You must be signed in to change notification settings

QuickDevelopment/wp-js

Repository files navigation

@quickdevelopment/wp-js · npm version

Get all your public WordPress data through the WP API using a tree-shakable TypeScript library.

Table of Contents
  1. Installation
  2. Usage
  3. Coming up
  4. Contributing
  5. License

Installation

npm install @quickdevelopment/wp-js

Usage

Setting the Config

// src/main.ts
import { ConfigManager } from "@quickdevelopment/wp-js";

ConfigManager.getInstance({
    // Replace with your WordPress API URL
    apiUrl: 'https://developer.wordpress.org/wp-json/wp/v2',
    embed: true
});

Retrieve Posts

This is an example of how to retrieve posts from your WordPress site using the Post class.

import {Post, PostDataType} from "@quickdevelopment/wp-js";

const posts = new Post()

posts.fetch().then((posts: PostDataType[]) => {
  console.log(posts);
})
.catch((err) => {
  console.log(err);
});

Documentation

For more information about the library, see the documentation.

Coming up

  • Add more API classes to retrieve data from the WP API
  • Examples of how to use the library in multiple contexts
  • Add a documentation site

Contributing

If you want to contribute to this project, see CONTRIBUTING for details.

License

MIT © Quickdevelopment. See LICENSE for details.