Class ClientModel<T>Abstract

Type Parameters

  • T extends ModelDefinition<any, any, any>

Hierarchy (view full)

Constructors

constructor

Properties

annotated? busy collection data delete patch persist

Accessors

key

Methods

afterDelete afterPatch afterPersist fromResponse transformDataForPatch transformDataForPersist annotate?

Constructors

constructor

  • new ClientModel<T>(collection, data?): ClientModel<T>

  • Type Parameters

    • T extends ModelDefinition<any, any, any>

    Parameters

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

    Returns ClientModel<T>

Properties

Optional Readonly annotated

annotated?: AnnotateDefinition

busy

busy: boolean = false

collection

collection: T["collection"]

data

data: T["properties"] = {}

delete

delete: ((params?, settings?) => CancellablePromise<T["delete"]["response"]>) = ...

Type declaration

    • (params?, settings?): CancellablePromise<T["delete"]["response"]>

    • Parameters

      • Optional params: T["delete"]["parameters"]
      • Optional settings: Pick<{
            allowBatchRequest?: boolean | Pick<{
                restNamespace: string;
                restNonce?: string;
                restPathObfuscateOffset?: string;
                restQuery?: object;
                restRecreateNonceEndpoint?: string;
                restRoot: string;
            } & {
                onQueueItemFinished?: ((state) => void);
                signal?: AbortSignal;
                waitForPromise?: Promise<void>;
            }, "onQueueItemFinished" | "waitForPromise">;
            multipart?: boolean | MultiPartOptions;
            params?: IRouteParamsInterface;
            replayReason?: ReplayReason;
            request?: IRouteRequestInterface;
            sendReferer?: boolean;
            sendRestNonce?: boolean;
            settings?: Partial<{
                body: ReadableStream<Uint8Array>;
                bodyUsed: boolean;
                cache: RequestCache;
                credentials: RequestCredentials;
                destination: RequestDestination;
                headers: Headers;
                integrity: string;
                keepalive: boolean;
                method: string;
                mode: RequestMode;
                redirect: RequestRedirect;
                referrer: string;
                referrerPolicy: ReferrerPolicy;
                signal: AbortSignal;
                url: string;
                arrayBuffer(): Promise<ArrayBuffer>;
                blob(): Promise<Blob>;
                clone(): Request;
                formData(): Promise<FormData>;
                json(): Promise<any>;
                text(): Promise<string>;
            }>;
        } & UrlBuilderArgs, "settings" | "allowBatchRequest">

        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

patch: ((params?) => CancellablePromise<void>) = ...

Type declaration

    • (params?): CancellablePromise<void>

    • Parameters

      • Optional params: T["patch"]["parameters"]

      Returns CancellablePromise<void>

persist

persist: ((params?, settings?) => CancellablePromise<void>) = ...

Type declaration

    • (params?, settings?): CancellablePromise<void>

    • Parameters

      • Optional params: T["create"]["parameters"]
      • Optional settings: Pick<{
            allowBatchRequest?: boolean | Pick<{
                restNamespace: string;
                restNonce?: string;
                restPathObfuscateOffset?: string;
                restQuery?: object;
                restRecreateNonceEndpoint?: string;
                restRoot: string;
            } & {
                onQueueItemFinished?: ((state) => void);
                signal?: AbortSignal;
                waitForPromise?: Promise<void>;
            }, "onQueueItemFinished" | "waitForPromise">;
            multipart?: boolean | MultiPartOptions;
            params?: IRouteParamsInterface;
            replayReason?: ReplayReason;
            request?: IRouteRequestInterface;
            sendReferer?: boolean;
            sendRestNonce?: boolean;
            settings?: Partial<{
                body: ReadableStream<Uint8Array>;
                bodyUsed: boolean;
                cache: RequestCache;
                credentials: RequestCredentials;
                destination: RequestDestination;
                headers: Headers;
                integrity: string;
                keepalive: boolean;
                method: string;
                mode: RequestMode;
                redirect: RequestRedirect;
                referrer: string;
                referrerPolicy: ReferrerPolicy;
                signal: AbortSignal;
                url: string;
                arrayBuffer(): Promise<ArrayBuffer>;
                blob(): Promise<Blob>;
                clone(): Request;
                formData(): Promise<FormData>;
                json(): Promise<any>;
                text(): Promise<string>;
            }>;
        } & UrlBuilderArgs, "settings" | "allowBatchRequest">

        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

key

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

  • Returns T["key"]

Methods

afterDelete

  • afterDelete(): void

  • Returns void

afterPatch

  • afterPatch(): void

  • Returns void

afterPersist

  • afterPersist(): void

  • Returns void

fromResponse

  • fromResponse(response): ClientModel<T>

  • Parameters

    • response: T["properties"]

    Returns ClientModel<T>

transformDataForPatch

  • transformDataForPatch(): any

  • Create your conditionals here and return only changed values.

    Returns any

transformDataForPersist

  • transformDataForPersist(): 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

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

    • annotate: AnnotateDefinition

    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

constructorannotatedbusycollectiondatadeletepatchpersistkeyafterDeleteafterPatchafterPersistfromResponsetransformDataForPatchtransformDataForPersistannotate