Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ChecklistStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns ChecklistStore

Properties

busyChecklist

busyChecklist: boolean = false

checklist

checklist: ResponseRouteChecklistGet

Optional chunkFolder

chunkFolder: string

Optional chunks

chunks: Record<string, string[]>

fetchChecklist

fetchChecklist: () => Promise<void> = flow(function* (this: ChecklistStore) {this.busyChecklist = true;try {this.checklist = yield request<RequestRouteChecklistGet,ParamsRouteChecklistGet,ResponseRouteChecklistGet>({location: locationRestChecklistGet,params: {_wp_http_referer: window.location.href}});} catch (e) {console.log(e);throw e;} finally {this.busyChecklist = false;}})

Type declaration

    • (): Promise<void>

    • Returns Promise<void>

probablyFetchByChangedItem

probablyFetchByChangedItem: (itemId: string | string[], force?: boolean) => Promise<void> = flow(function* (this: ChecklistStore,itemId,force) {if (force) {yield this.fetchChecklist();return;}const useItemIds = !Array.isArray(itemId) ? [itemId] : itemId;if (this.items.filter(({ id, checked }) => useItemIds.indexOf(id) > -1 && !checked).length > 0) {yield this.fetchChecklist();}})

Type declaration

    • (itemId: string | string[], force?: boolean): Promise<void>

    • Parameters

      • itemId: string | string[]
      • Optional force: boolean

      Returns Promise<void>

Optional publicUrl

publicUrl: string

Optional restNamespace

restNamespace: string

Optional restNonce

restNonce: string

Optional restQuery

restQuery: {}

Type declaration

Optional restRecreateNonceEndpoint

restRecreateNonceEndpoint: string

Optional restRoot

restRoot: string

Optional restUrl

restUrl: string

Readonly rootStore

rootStore: RootStore

slug

slug: string

textDomain

textDomain: string

toggleChecklistItem

toggleChecklistItem: (id: string, state: boolean) => Promise<void> = flow(function* (this: ChecklistStore,id,state) {this.busyChecklist = true;try {this.checklist = yield request<RequestRouteChecklistPut,ParamsRouteChecklistPut,ResponseRouteChecklistPut>({location: locationRestChecklistPut,request: {state},params: {id,_wp_http_referer: window.location.href}});} catch (e) {console.log(e);throw e;} finally {this.busyChecklist = false;}})

Type declaration

    • (id: string, state: boolean): Promise<void>

    • Parameters

      • id: string
      • state: boolean

      Returns Promise<void>

version

version: string

Accessors

checkable

  • get checkable(): { id: string }[]

  • Returns { id: string }[]

completed

  • get completed(): { id: string }[]

  • Returns { id: string }[]

done

  • get done(): boolean

  • Returns boolean

items

  • get items(): { id: string }[]

  • Returns { id: string }[]

Methods

Static getPureSlug

  • getPureSlug(slug: string, camelCase?: boolean): string

  • Get the slug from the current process (webpack) instead of the PHP plugin output. For some cases you need to use that.

    Parameters

    • slug: string
    • Default value camelCase: boolean = false

    Returns string

Static slugCamelCase

  • slugCamelCase(slug: string): string

  • Convert a slug like "my-plugin" to "myPlugin". This can be useful for library naming (window[""] is bad because the hyphens).

    Parameters

    • slug: string

    Returns string

Generated using TypeDoc