core/updates | Unmagical API Reference

Types

Repository

Repository: { get: any; search: any; add: any; replace: any; remove: any }

Repository, which can search/add/replace/remove entities.

Type declaration

get:function
- get(id: string | number): Promise<Json>
- - Defined in src/core/updates.ts:16
  Parameters
  - id: string | number
  Returns Promise<Json>
search:function
- search(query: Record<string, any>): Promise<{ entities: Json[]; totalCount: number }>
- - Defined in src/core/updates.ts:17
  Parameters
  - query: Record<string, any>
  Returns Promise<{ entities: Json[]; totalCount: number }>
add:function
- add(entity: Json): Promise<Json>
- - Defined in src/core/updates.ts:18
  Parameters
  - entity: Json
  Returns Promise<Json>
replace:function
- replace(entity: Json): Promise<Json>
- - Defined in src/core/updates.ts:19
  Parameters
  - entity: Json
  Returns Promise<Json>
remove:function
- remove(entity: Json): Promise<void>
- - Defined in src/core/updates.ts:20
  Parameters
  - entity: Json
  Returns Promise<void>

For Entity List

Const editEntity

editEntity(entityPath: string, formPath: string, store: Store): Store

- Defined in src/core/updates.ts:33
Loads a specified entity to the form for editing.

Parameters
- entityPath: string
- formPath: string
- store: Store
Returns Store

Const makeEntity

makeEntity(data: Json, formPath: string, store: Store): Store

- Defined in src/core/updates.ts:45
Loads an initial data to the form for creating an entity.

Parameters
- data: Json
- formPath: string
- store: Store
Returns Store

CommitEntityOptions

CommitEntityOptions: { errorSelector?: string; loadingName?: string; successName?: string; failureName?: string }

Type declaration

Optional errorSelector?: string
Optional loadingName?: string
Optional successName?: string
Optional failureName?: string

Const commitEntity

commitEntity(repository: Repository): (formPath: string, listPath: string, options: CommitEntityOptions, store: Store) => Store | Promise<any>

- Defined in src/core/updates.ts:67
Stores the entity in the form into a repository.

Parameters
- repository: Repository
Returns (formPath: string, listPath: string, options: CommitEntityOptions, store: Store) => Store | Promise<any>
- - (formPath: string, listPath: string, options: CommitEntityOptions, store: Store): Store | Promise<any>
  - Parameters
    - formPath: string
    - listPath: string
    - options: CommitEntityOptions
    - store: Store
    Returns Store | Promise<any>

Const discardEntity

discardEntity(formPath: string, store: Store): Store

- Defined in src/core/updates.ts:124
Discard the entity in the form.

Parameters
- formPath: string
- store: Store
Returns Store

DeleteEntityOptions

DeleteEntityOptions: { confirmName?: string; loadingName?: string; successName?: string; failureName?: string }

Type declaration

Optional confirmName?: string
Optional loadingName?: string
Optional successName?: string
Optional failureName?: string

Const deleteEntity

deleteEntity(repository: Repository): (entityPath: string, listPath: string, options: DeleteEntityOptions, store: Store) => Store | Promise<any>

- Defined in src/core/updates.ts:143
Deletes an entity from a repository.

Parameters
- repository: Repository
Returns (entityPath: string, listPath: string, options: DeleteEntityOptions, store: Store) => Store | Promise<any>
- - (entityPath: string, listPath: string, options: DeleteEntityOptions, store: Store): Store | Promise<any>
  - Parameters
    - entityPath: string
    - listPath: string
    - options: DeleteEntityOptions
    - store: Store
    Returns Store | Promise<any>

LoadEntitiesOptions

LoadEntitiesOptions: { loadingName?: string; failureName?: string; page?: number; pageProperty?: string }

Type declaration

Optional loadingName?: string
Optional failureName?: string
Optional page?: number
Optional pageProperty?: string

Const loadEntities

loadEntities(repository: Repository): (listPath: string, options: LoadEntitiesOptions, store: Store) => Store | Promise<any>

- Defined in src/core/updates.ts:198
Fetches entities from a repository

Parameters
- repository: Repository
Returns (listPath: string, options: LoadEntitiesOptions, store: Store) => Store | Promise<any>
- - (listPath: string, options: LoadEntitiesOptions, store: Store): Store | Promise<any>
  - Parameters
    - listPath: string
    - options: LoadEntitiesOptions
    - store: Store
    Returns Store | Promise<any>

SearchEntitiesOptions

SearchEntitiesOptions: { errorSelector?: string; loadingName?: string; failureName?: string }

Type declaration

Optional errorSelector?: string
Optional loadingName?: string
Optional failureName?: string

Const searchEntities

searchEntities(repository: Repository): (formPath: string, listPath: string, options: SearchEntitiesOptions, store: Store) => Store | Promise<any>

- Defined in src/core/updates.ts:246
Searches entities from a repository

Parameters
- repository: Repository
Returns (formPath: string, listPath: string, options: SearchEntitiesOptions, store: Store) => Store | Promise<any>
- - (formPath: string, listPath: string, options: SearchEntitiesOptions, store: Store): Store | Promise<any>
  - Parameters
    - formPath: string
    - listPath: string
    - options: SearchEntitiesOptions
    - store: Store
    Returns Store | Promise<any>

Const makeEntityListUpdates

makeEntityListUpdates(repository: Repository): Record<string, Update>

- Defined in src/core/updates.ts:296
Helper function. Builds a neat update collection for entity list app.

Parameters
- repository: Repository
Returns Record<string, Update>

For Single Entity

SubmitOptions

SubmitOptions: { path?: string; errorSelector?: string; loadingName?: string; successName?: string; failureName?: string }

Type declaration

Optional path?: string
Optional errorSelector?: string
Optional loadingName?: string
Optional successName?: string
Optional failureName?: string

Const submit

submit(repository: Repository): (method: "add" | "replace", options: SubmitOptions, store: Store) => Store | Promise<any>

- Defined in src/core/updates.ts:323
Submits data to a repository. The method can be "add" or "replace".

Parameters
- repository: Repository
Returns (method: "add" | "replace", options: SubmitOptions, store: Store) => Store | Promise<any>
- - (method: "add" | "replace", options: SubmitOptions, store: Store): Store | Promise<any>
  - Parameters
    - method: "add" | "replace"
    - options: SubmitOptions
    - store: Store
    Returns Store | Promise<any>

ResetOptions

ResetOptions: { confirmName?: string }

Type declaration

Optional confirmName?: string

Const reset

reset(data: Json, options: ResetOptions, store: Store): Store | Promise<any>

- Defined in src/core/updates.ts:375
Resets data.

Parameters
- data: Json
- options: ResetOptions
- store: Store
Returns Store | Promise<any>

Const editPart

editPart(partPath: string, formPath: string, store: Store): Store

- Defined in src/core/updates.ts:396
Loads a part of the entity into the form for editing.

Parameters
- partPath: string
- formPath: string
- store: Store
Returns Store

Const makePart

makePart(pathToAdd: string, data: Json, formPath: string, store: Store): Store

- Defined in src/core/updates.ts:410
Loads data into the form for createing a part of the entity.

Parameters
- pathToAdd: string
- data: Json
- formPath: string
- store: Store
Returns Store

CommitPartOptions

CommitPartOptions: { errorSelector?: string; idProperty?: string }

Type declaration

Optional errorSelector?: string
Optional idProperty?: string

Const commitPart

commitPart(formPath: string, nextIdPath: string, options: CommitPartOptions, store: Store): Store

- Defined in src/core/updates.ts:432
Stores the part in the form into the entity.

Parameters
- formPath: string
- nextIdPath: string
- options: CommitPartOptions
- store: Store
Returns Store

Const discardPart

discardPart(formPath: string, store: Store): Store

- Defined in src/core/updates.ts:475
Discards data in the form.

Parameters
- formPath: string
- store: Store
Returns Store

RemovePartOptions

RemovePartOptions: { confirmName?: string }

Type declaration

Optional confirmName?: string

Const removePart

removePart(partPath: string, options: RemovePartOptions, store: Store): Store | Promise<any>

- Defined in src/core/updates.ts:491
Removes a part of the entity.

Parameters
- partPath: string
- options: RemovePartOptions
- store: Store
Returns Store | Promise<any>

CopyPartOptions

CopyPartOptions: { pathToAdd?: string; idProperty?: string }

Type declaration

Optional pathToAdd?: string
Optional idProperty?: string

Const copyPart

copyPart(partPath: string, nextIdPath: string, options: CopyPartOptions, store: Store): Store

- Defined in src/core/updates.ts:521
Copies a part of the entity.

Parameters
- partPath: string
- nextIdPath: string
- options: CopyPartOptions
- store: Store
Returns Store

Const makeEntityUpdates

makeEntityUpdates(repository: Repository): Record<string, Update>

- Defined in src/core/updates.ts:542
Helper function. Builds a neat update collection for single entity app.

Parameters
- repository: Repository
Returns Record<string, Update>

Other

SingularRepository

SingularRepository: { get: any; replace: any }

Type declaration

get:function
- get(): Promise<Json>
- - Defined in src/core/updates.ts:24
  Returns Promise<Json>
replace:function
- replace(entity: Json): Promise<Json>
- - Defined in src/core/updates.ts:25
  Parameters
  - entity: Json
  Returns Promise<Json>

Index

Types

For Entity List

For Single Entity

Other

Types

Repository

Type declaration

get:function

Parameters

id: string | number

Returns Promise<Json>

search:function

Parameters

query: Record<string, any>

Returns Promise<{ entities: Json[]; totalCount: number }>

add:function

Parameters

entity: Json

Returns Promise<Json>

replace:function

Parameters

entity: Json

Returns Promise<Json>

remove:function

Parameters

entity: Json

Returns Promise<void>

For Entity List

Const editEntity

Parameters

entityPath: string

formPath: string

store: Store

Returns Store

Const makeEntity

Parameters

data: Json

formPath: string

store: Store

Returns Store

CommitEntityOptions

Type declaration

Optional errorSelector?: string

Optional loadingName?: string

Optional successName?: string

Optional failureName?: string

Const commitEntity

Parameters

repository: Repository

Returns (formPath: string, listPath: string, options: CommitEntityOptions, store: Store) => Store | Promise<any>

Parameters

formPath: string

listPath: string

options: CommitEntityOptions

store: Store

Returns Store | Promise<any>

Const discardEntity

Parameters

formPath: string

store: Store

Returns Store

DeleteEntityOptions

Type declaration

Optional confirmName?: string

Optional loadingName?: string

Optional successName?: string

Optional failureName?: string

Const deleteEntity

Parameters

repository: Repository

Returns (entityPath: string, listPath: string, options: DeleteEntityOptions, store: Store) => Store | Promise<any>

Parameters

entityPath: string

listPath: string

options: DeleteEntityOptions

store: Store

Returns Store | Promise<any>

LoadEntitiesOptions

Type declaration