wordpress-api/lib/Tags.ts

Wordpress API

import { RequestHandler } from './interface/RequestHandler';
import { CreateTag, DeleteTag, GetTag, ListTags, Tag, UpdateTag } from './interface/Tags';

export const Tags = (API_URL: string, makeRequest: RequestHandler) => {
    const objectEndpoint = 'tags';
    return {
        /**
         * Create a tag
         * @param options - options to create a tag
         */
        createTag: async (options: CreateTag) => {
            const url = `${API_URL}/${objectEndpoint}`;
            const response = await makeRequest(url, { method: 'POST', data: options });
            return response.data as Tag;
        },

        /**
         * Remove a tag
         * @param id - tag id to remove
         * @param options - remove options
         * @default: { force: true }
         */
        deleteTag: async (id: number, options: DeleteTag = { force: true }) => {
            const url = `${API_URL}/${objectEndpoint}/${id}`;
            const response = await makeRequest(url, { method: 'DELETE', data: options });
            return response.data.deleted;
        },

        /**
         * Get specific tag with id
         * @param id - tag id
         * @param options - get options
         * @default: { context: 'view' }
         */
        getTag: async (id: number, options: GetTag = { context: 'view' }) => {
            const url = `${API_URL}/${objectEndpoint}/${id}`;
            const response = await makeRequest(url, { method: 'GET', data: options });
            return response.data as Tag;
        },

        /**
         * Get all Tags
         * @param options - options to retrieve a tags
         * @default: {}
         */
        getTags: async (options: ListTags = {}) => {
            const url = `${API_URL}/${objectEndpoint}`;
            const response = await makeRequest(url, { method: 'GET', data: options });
            return response.data as Tag[];
        },

        /**
         * Update a specific tag
         * @param id - which post to update
         * @param options - options to update a tag
         */
        updateTag: async (id: number, options: UpdateTag) => {
            const url = `${API_URL}/${objectEndpoint}/${id}`;
            const response = await makeRequest(url, { method: 'POST', data: options });
            return response.data as Tag;
        },
    };
};