devowl-wp
    Preparing search index...

    Class ClientModel<T>Abstract

    Type Parameters

    • T extends ModelDefinition<any, any, any>

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    annotated? busy collection data delete patch persist

    Accessors

    key

    Methods

    afterDelete afterPatch afterPersist fromResponse transformDataForPatch transformDataForPersist annotate?

    Constructors

    • Type Parameters

      • T extends ModelDefinition<any, any, any>

      Parameters

      • collection: T["collection"]
      • data: Partial<T["properties"]> = {}

      Returns ClientModel<T>

    Properties

    annotated?: AnnotateDefinition
    busy: boolean = false
    collection: T["collection"]
    data: T["properties"] = {}
    delete: (
        params?: T["delete"]["parameters"],
        settings?: Pick<
            Parameters<typeof commonRequest>[0],
            "allowBatchRequest" | "settings",
        >,
    ) => CancellablePromise<T["delete"]["response"]> = ...

    Type declaration

      • (
            params?: T["delete"]["parameters"],
            settings?: Pick<
                Parameters<typeof commonRequest>[0],
                "allowBatchRequest" | "settings",
            >,
        ): CancellablePromise<T["delete"]["response"]>

      • Parameters

        • Optionalparams: T["delete"]["parameters"]
        • Optionalsettings: Pick<Parameters<typeof commonRequest>[0], "allowBatchRequest" | "settings">

          When you pass allowBatchRequest, the afterDelete is not called due to performance reasons. Please call afterDelete and this.collection.entries.delete manually!

        Returns CancellablePromise<T["delete"]["response"]>

    patch: (params?: T["patch"]["parameters"]) => CancellablePromise<void> = ...
    persist: (
        params?: T["create"]["parameters"],
        settings?: Pick<
            Parameters<typeof commonRequest>[0],
            "allowBatchRequest" | "settings",
        >,
    ) => CancellablePromise<void> = ...

    Type declaration

      • (
            params?: T["create"]["parameters"],
            settings?: Pick<
                Parameters<typeof commonRequest>[0],
                "allowBatchRequest" | "settings",
            >,
        ): CancellablePromise<void>

      • Parameters

        • Optionalparams: T["create"]["parameters"]
        • Optionalsettings: Pick<Parameters<typeof commonRequest>[0], "allowBatchRequest" | "settings">

          When you pass allowBatchRequest, the afterPersist is not called due to performance reasons. Please call afterPersist and this.collection.entries.set manually!

        Returns CancellablePromise<void>

    Accessors

    • get key(): T["key"]

      Returns T["key"]

    Methods

    • Returns void

    • Returns void

    • Returns void

    • Parameters

      • response: T["properties"]

      Returns ClientModel<T>

    • Create your conditionals here and return only changed values.

      Returns any

    • Transform the class-hold data to POSTable data. This can be useful if e. g. one property differs from the response property schema.

      Returns any

    • Type Parameters

      • T extends new (...args: any[]) => any

      Parameters

      • annotate: AnnotateDefinition

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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods