Class AbstractPostCollection<T, AdditionalParameters, AdditionalSingleParameters>Abstract

Type Parameters

  • T extends AbstractPost
  • AdditionalParameters = object
  • AdditionalSingleParameters = object

Hierarchy (view full)

  • ClientCollection<{
        getParameters: {
            after?: string;
            author?: string | number | string[] | number[];
            author_exclude?: string | number | string[] | number[];
            before?: string;
            categories?: number[];
            categories_exclude?: number[];
            context?: "view" | "embed" | "edit";
            exclude?: number[];
            include?: number[];
            offset?: number;
            order?: "asc" | "desc";
            orderby?: "author" | "date" | "id" | "include" | "modified" | "parent" | "relevance" | "slug" | "include_slugs" | "title" | string;
            page?: number;
            per_page?: number;
            search?: string;
            slug?: string | string[];
            status?: PostStatus | PostStatus[];
            sticky?: boolean;
            tags?: number[];
            tags_exclude?: number[];
            tax_relation?: "AND" | "OR";
        } & AdditionalParameters;
        getSingleParameters: {
            context?: "view" | "embed" | "edit";
            id: number;
        } & AdditionalSingleParameters;
        model: T;
    }>
    • AbstractPostCollection

Constructors

constructor

Properties

annotated? busy entries get getSingle

Methods

instance annotate?

Constructors

constructor

Properties

Optional Readonly annotated

annotated?: AnnotateDefinition

busy

busy: boolean = false

entries

entries: Map<T["key"], T> = ...

get

get: ((data?) => CancellablePromise<void>) = ...

Type declaration

    • (data?): CancellablePromise<void>

    • Parameters

      • Optional data: {
            clear?: boolean;
            params?: {
                after?: string;
                author?: string | number | string[] | number[];
                author_exclude?: string | number | string[] | number[];
                before?: string;
                categories?: number[];
                categories_exclude?: number[];
                context?: "embed" | "view" | "edit";
                exclude?: number[];
                include?: number[];
                offset?: number;
                order?: "asc" | "desc";
                orderby?: string;
                page?: number;
                per_page?: number;
                search?: string;
                slug?: string | string[];
                status?: PostStatus | PostStatus[];
                sticky?: boolean;
                tags?: number[];
                tags_exclude?: number[];
                tax_relation?: "AND" | "OR";
            } & AdditionalParameters;
            request?: {
                after?: string;
                author?: string | number | string[] | number[];
                author_exclude?: string | number | string[] | number[];
                before?: string;
                categories?: number[];
                categories_exclude?: number[];
                context?: "embed" | "view" | "edit";
                exclude?: number[];
                include?: number[];
                offset?: number;
                order?: "asc" | "desc";
                orderby?: string;
                page?: number;
                per_page?: number;
                search?: string;
                slug?: string | string[];
                status?: PostStatus | PostStatus[];
                sticky?: boolean;
                tags?: number[];
                tags_exclude?: number[];
                tax_relation?: "AND" | "OR";
            } & AdditionalParameters;
        }
        • Optional clear?: boolean
        • Optional params?: {
              after?: string;
              author?: string | number | string[] | number[];
              author_exclude?: string | number | string[] | number[];
              before?: string;
              categories?: number[];
              categories_exclude?: number[];
              context?: "embed" | "view" | "edit";
              exclude?: number[];
              include?: number[];
              offset?: number;
              order?: "asc" | "desc";
              orderby?: string;
              page?: number;
              per_page?: number;
              search?: string;
              slug?: string | string[];
              status?: PostStatus | PostStatus[];
              sticky?: boolean;
              tags?: number[];
              tags_exclude?: number[];
              tax_relation?: "AND" | "OR";
          } & AdditionalParameters
        • Optional request?: {
              after?: string;
              author?: string | number | string[] | number[];
              author_exclude?: string | number | string[] | number[];
              before?: string;
              categories?: number[];
              categories_exclude?: number[];
              context?: "embed" | "view" | "edit";
              exclude?: number[];
              include?: number[];
              offset?: number;
              order?: "asc" | "desc";
              orderby?: string;
              page?: number;
              per_page?: number;
              search?: string;
              slug?: string | string[];
              status?: PostStatus | PostStatus[];
              sticky?: boolean;
              tags?: number[];
              tags_exclude?: number[];
              tax_relation?: "AND" | "OR";
          } & AdditionalParameters

      Returns CancellablePromise<void>

getSingle

getSingle: ((data?) => CancellablePromise<void>) = ...

Type declaration

    • (data?): CancellablePromise<void>

    • Parameters

      • Optional data: {
            params?: {
                context?: "embed" | "view" | "edit";
                id: number;
            } & AdditionalSingleParameters;
            request?: {
                context?: "embed" | "view" | "edit";
                id: number;
            } & AdditionalSingleParameters;
        }

      Returns CancellablePromise<void>

Methods

Abstract instance

  • instance(response): T

  • Parameters

    • response: unknown

    Returns T

Static Optional annotate

  • annotate<T>(annotate): ((constructor) => {
        prototype: __type<any, any>;
        new (...args): __type<T, T>;
    } & T)

  • Type Parameters

    • T extends (new (...args) => any)

    Parameters

    Returns ((constructor) => {
        prototype: __type<any, any>;
        new (...args): __type<T, T>;
    } & T)

      • (constructor): {
            prototype: __type<any, any>;
            new (...args): __type<T, T>;
        } & T

      • Parameters

        • constructor: T

        Returns {
            prototype: __type<any, any>;
            new (...args): __type<T, T>;
        } & T

Settings

Member Visibility

Theme

On This Page

constructorannotatedbusyentriesgetgetSingleinstanceannotate