Skip to content

Fix readme #73

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
keygun-development merged 1 commit into from
Feb 14, 2024
Merged

Fix readme #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ import {Post, PostDataType} from "@quickdevelopment/wp-js";

const posts = new Post()

posts.fetchMany().then((posts: PostDataType[]) => {
posts.fetch().then((posts: PostDataType[]) => {
console.log(posts);
})
.catch((err) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ <h2>@quickdevelopment/wp-js &middot; <a href="https://badge.fury.io/js/@quickdev
<a id="md:usage" class="tsd-anchor"></a><h2><a href="#md:usage">Usage</a></h2><a id="md:setting-the-config" class="tsd-anchor"></a><h3><a href="#md:setting-the-config">Setting the Config</a></h3><pre><code><span class="hl-2">// src/main.ts</span><br/><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-0">ConfigManager</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">&quot;@quickdevelopment/wp-js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-0">ConfigManager</span><span class="hl-1">.</span><span class="hl-5">getInstance</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-2">// Replace with your WordPress API URL</span><br/><span class="hl-1"> </span><span class="hl-0">apiUrl:</span><span class="hl-1"> </span><span class="hl-4">&#39;https://developer.wordpress.org/wp-json/wp/v2&#39;</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-0">embed:</span><span class="hl-1"> </span><span class="hl-6">true</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<a id="md:retrieve-posts" class="tsd-anchor"></a><h3><a href="#md:retrieve-posts">Retrieve Posts</a></h3><p>This is an example of how to retrieve posts from your WordPress site using the <code>Post</code> class.</p>
<pre><code><span class="hl-3">import</span><span class="hl-1"> {</span><span class="hl-0">Post</span><span class="hl-1">, </span><span class="hl-0">PostDataType</span><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">&quot;@quickdevelopment/wp-js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">posts</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-5">Post</span><span class="hl-1">()</span><br/><br/><span class="hl-0">posts</span><span class="hl-1">.</span><span class="hl-5">fetchMany</span><span class="hl-1">().</span><span class="hl-5">then</span><span class="hl-1">((</span><span class="hl-0">posts</span><span class="hl-1">: </span><span class="hl-8">PostDataType</span><span class="hl-1">[]) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">posts</span><span class="hl-1">);</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-5">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
<pre><code><span class="hl-3">import</span><span class="hl-1"> {</span><span class="hl-0">Post</span><span class="hl-1">, </span><span class="hl-0">PostDataType</span><span class="hl-1">} </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-4">&quot;@quickdevelopment/wp-js&quot;</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">posts</span><span class="hl-1"> = </span><span class="hl-6">new</span><span class="hl-1"> </span><span class="hl-5">Post</span><span class="hl-1">()</span><br/><br/><span class="hl-0">posts</span><span class="hl-1">.</span><span class="hl-5">fetch</span><span class="hl-1">().</span><span class="hl-5">then</span><span class="hl-1">((</span><span class="hl-0">posts</span><span class="hl-1">: </span><span class="hl-8">PostDataType</span><span class="hl-1">[]) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">posts</span><span class="hl-1">);</span><br/><span class="hl-1">})</span><br/><span class="hl-1">.</span><span class="hl-5">catch</span><span class="hl-1">((</span><span class="hl-0">err</span><span class="hl-1">) </span><span class="hl-6">=&gt;</span><span class="hl-1"> {</span><br/><span class="hl-1"> </span><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-5">log</span><span class="hl-1">(</span><span class="hl-0">err</span><span class="hl-1">);</span><br/><span class="hl-1">});</span>
</code><button>Copy</button></pre>
<a id="md:documentation" class="tsd-anchor"></a><h2><a href="#md:documentation">Documentation</a></h2><p>For more information about the library, see the <a href="https://quickdevelopment.github.io/wp-js/">documentation</a>.</p>
<a id="md:coming-up" class="tsd-anchor"></a><h2><a href="#md:coming-up">Coming up</a></h2><ul>
Expand Down