Class Tag<T>

The Tag class.

Since

3.0.0

Type Parameters

  • T = PostTagDataType[] | PostTagDataType

Hierarchy (view full)

Constructors

constructor

Properties

endpoint _instance

Methods

fetch fetchMany get getSearchParams setSearchParams getInstance

Constructors

constructor

  • new Tag<T>(endpoint?): Tag<T>

  • Type Parameters

    • T = default | default[]

    Parameters

    • Optional endpoint: string

    Returns Tag<T>

Properties

Protected endpoint

endpoint: string = 'posts'

Static Protected _instance

_instance: WPJSSingleton

Methods

fetch

  • fetch(): Promise<T | T[]>

  • Fetch a single tag.

    Returns Promise<T | T[]>

    Since

    3.0.0

    Example

    import { Tag } from '@quickdevelopment/wp-js';

    const tag = new Tag();

    tag.fetch().then((data) => {
       console.log(data);
    })

Protected fetchMany

  • fetchMany(): Promise<T[]>
  • Protected

    Fetch multiple objects from the endpoint.

    Returns Promise<T[]>

    Since

    2.0.0

Protected get

  • get<T>(): Promise<T>
  • Protected

    Get data about the current class.

    Type Parameters

    • T

    Returns Promise<T>

    Since

    1.0.0

Protected getSearchParams

  • getSearchParams(): URLSearchParams
  • Protected

    Get the search parameters.

    Returns URLSearchParams

Protected setSearchParams

  • setSearchParams(params): this

  • Set search parameters for the request.

    Parameters

    • params: Record<string, string | number>

      Object containing search parameters.

    Returns this

    Since

    2.0.0

Static getInstance

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc