Class WPJSBase<T>

Base class for all WPJS classes.

Since

1.0.0

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

_apiUrl _searchParams endpoint _instance

Methods

constructUrl fetch fetchMany get getApiUrl getEndpoint getSearchParams setSearchParams getInstance

Constructors

constructor

Properties

Private Readonly _apiUrl

_apiUrl: string = ...

Private _searchParams

_searchParams: URLSearchParams = ...

Protected endpoint

endpoint: string = 'posts'

Static Protected _instance

_instance: WPJSSingleton

Methods

Private constructUrl

  • constructUrl(): string
  • Private

    Construct the url for the request.

    Returns string

    Since

    1.0.0

Protected fetch

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

    Fetch a single object from the endpoint.

    Returns Promise<T | T[]>

    Since

    2.0.0

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

Private getApiUrl

  • getApiUrl(): string
  • Private

    Get the API url.

    Returns string

Private getEndpoint

  • getEndpoint(): string
  • Private

    Get the endpoint.

    Returns string

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