Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CookieModel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new CookieModel(collection: CookieModel["collection"], data?: Partial<CookieModel["data"]>): CookieModel

  • Parameters

    • collection: CookieModel["collection"]
    • Default value data: Partial<CookieModel["data"]> = {}

    Returns CookieModel

Properties

Optional Readonly annotated

annotated: AnnotateDefinition

busy

busy: boolean = false

collection

collection: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["collection"]

data

data: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["properties"]

delete

delete: (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["parameters"]) => CancellablePromise<{ collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["response"]> = flow(function* (this: ClientModel<any>, params) {if (!this.annotated.delete) {throw new Error("There is no delete method allowed");}this.busy = true;try {const {delete: { path, method },namespace} = this.annotated;const response: T["delete"]["response"] = yield this.annotated.request<T["delete"]["parameters"],T["delete"]["parameters"],T["delete"]["response"]>({location: {path,method: method || ERouteHttpVerb.DELETE,namespace},params: {...{ [this.annotated.keyId]: this.key },...(params || {})}});this.collection.entries.delete(this.key);this.afterDelete();return response;} catch (e) {console.log(e);throw e;} finally {this.busy = false;}})

Type declaration

    • (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["parameters"]): CancellablePromise<{ collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["response"]>

    • Parameters

      • Optional params: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["parameters"]

      Returns CancellablePromise<{ collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["delete"]["response"]>

patch

patch: (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["patch"]["parameters"]) => CancellablePromise<void> = flow(function* (this: ClientModel<any>,params) {if (!this.annotated.patch) {throw new Error("There is no patch method allowed");}this.busy = true;try {const {patch: { path, method },namespace} = this.annotated;const response: T["patch"]["response"] = yield this.annotated.request<T["patch"]["request"],T["patch"]["parameters"],T["patch"]["response"]>({location: {path,method: method || ERouteHttpVerb.PATCH,namespace},request: this.transformDataForPatch(),params: {...{ [this.annotated.keyId]: this.key },...(params || {})}});this.fromResponse(response);this.afterPatch();} catch (e) {console.log(e);throw e;} finally {this.busy = false;}})

Type declaration

    • (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["patch"]["parameters"]): CancellablePromise<void>

    • Parameters

      • Optional params: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["patch"]["parameters"]

      Returns CancellablePromise<void>

persist

persist: (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["create"]["parameters"]) => CancellablePromise<void> = flow(function* (this: ClientModel<any>,params) {if (!this.annotated.create) {throw new Error("There is no persist method allowed");}this.busy = true;try {const {create: { path, method },namespace} = this.annotated;const response: T["create"]["response"] = yield this.annotated.request<T["create"]["request"],T["create"]["parameters"],T["create"]["response"]>({location: {path,method: method || ERouteHttpVerb.POST,namespace},request: this.transformDataForPersist(),params: params || {}});this.fromResponse(response);this.collection.entries.set(this.key, this);this.afterPersist();} catch (e) {console.log(e);throw e;} finally {this.busy = false;}})

Type declaration

    • (params?: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["create"]["parameters"]): CancellablePromise<void>

    • Parameters

      • Optional params: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["create"]["parameters"]

      Returns CancellablePromise<void>

Optional presetModel

presetModel: CookiePreset

Readonly store

store: CookieStore

Accessors

codeDynamics

  • get codeDynamics(): Record<string, string>

  • Returns Record<string, string>

key

  • get key(): { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["key"]

  • Returns { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["key"]

rootStore

  • Returns RootStore

technicalDefinitions

Methods

afterDelete

  • afterDelete(): void

  • Returns void

afterPatch

  • afterPatch(): void

  • Returns void

afterPersist

  • afterPersist(): void

  • Returns void

fromResponse

  • fromResponse(response: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["properties"]): this

  • Parameters

    • response: { collection: CookieCollection; delete: { parameters: { force?: boolean; id?: number }; response: (PostProperties & Data & { meta: Meta }) | { deleted: true; previous: PostProperties & Data & { meta: Meta } } }; key: number; patch: { parameters: { id?: number } }; properties: PostProperties & Data & { meta: Meta } }["properties"]

    Returns this

setGroup

  • setGroup(group: number): void

  • Parameters

    • group: number

    Returns void

setMeta

  • setMeta(meta: CookieModel["data"]["meta"]): void

  • Parameters

    • meta: CookieModel["data"]["meta"]

    Returns void

setName

  • setName(name: string): void

  • Parameters

    • name: string

    Returns void

setOrder

  • setOrder(order: number): void

  • Parameters

    • order: number

    Returns void

setPurpose

  • setPurpose(purpose: string): void

  • Parameters

    • purpose: string

    Returns void

setStatus

  • Parameters

    Returns void

transformDataForPatch

  • transformDataForPatch(): any

  • Returns any

transformDataForPersist

  • transformDataForPersist(): any

  • Returns any

Static Optional annotate

  • Type parameters

    • T: { constructor: any }

    Parameters

    Returns (Anonymous function)

Generated using TypeDoc