Class ListModel<D, F>`Abstract`

This basic class is a middle class, which isn't for direct using

Type Parameters

D extends DataObject
F extends Filter<D> = Filter<D>

Hierarchy

BaseListModel<D>
- ListModel

Index

Constructors

constructor

new ListModel<D, F>(): ListModel<D, F>
Type Parameters
- D extends DataObject
- F extends Partial<NewData<D>> = Partial<NewData<D>>
Returns ListModel<D, F>
Overrides BaseListModel.constructor
- Defined in source/List.ts:29

Properties

`Abstract` baseURI

baseURI: string

`Abstract` client

client: RESTClient

currentOne

currentOne: D = ...

downloading

downloading: number = 0

filter

filter: F = ...

indexKey

indexKey: keyof D = 'id'

pageIndex

pageIndex: number = 0

pageList

pageList: D[][] = []

pageSize

pageSize: number = 10

statistic

statistic: Partial<Record<TypeKeys<D, IndexKey>, Record<string, number>>> = {}

`Optional` totalCount

totalCount?: number = undefined

uploading

uploading: number = 0

validity

validity: Partial<Record<keyof D, {
[type: string]: string;
}>> = {}

Accessors

allItems

get allItems(): D[]
Returns D[]
- Defined in source/List.ts:62

currentPage

get currentPage(): D[]
Returns D[]
- Defined in source/List.ts:50

noMore

get noMore(): boolean
Returns boolean
- Defined in source/List.ts:79

pageCount

get pageCount(): number
Returns number
- Defined in source/List.ts:55

Methods

changeOne

changeOne(data, id, patch?): void
Parameters
- data: Partial<D>
- id: IDType
- patch: boolean = false
Returns void
- Defined in source/List.ts:213

clear

clear(): void
Returns void
Overrides BaseListModel.clear
- Defined in source/List.ts:97

clearCurrent

clearCurrent(): void
Returns void
Inherited from BaseListModel.clearCurrent
- Defined in source/Base.ts:60

clearList

clearList(): void
Returns void
- Defined in source/List.ts:89

countAll

countAll(keys, filter?, pageSize?): Promise<Partial<Record<TypeKeys<D, IndexKey>, Record<string, number>>>>
Parameters
- keys: TypeKeys<D, IndexKey>[]
- filter: F = ...
- pageSize: number = ...
Returns Promise<Partial<Record<TypeKeys<D, IndexKey>, Record<string, number>>>>
- Defined in source/List.ts:193

deleteOne

deleteOne(id): Promise<void>
Parameters
- id: IDType
Returns Promise<void>
Overrides BaseListModel.deleteOne
- Defined in source/List.ts:257

getAll

getAll(filter?, pageSize?): Promise<D[]>
Parameters
- filter: F = ...
- pageSize: number = ...
Returns Promise<D[]>
- Defined in source/List.ts:187

getList

getList(filter?, pageIndex?, pageSize?): Promise<D[]>
Parameters
- filter: F = ...
- pageIndex: number = ...
- pageSize: number = ...
Returns Promise<D[]>
- Defined in source/List.ts:162

getOne

getOne(id): Promise<D>
Parameters
- id: IDType
Returns Promise<D>
Inherited from BaseListModel.getOne
- Defined in source/Base.ts:80

indexOf

indexOf(id): number
Parameters
- id: IDType
Returns number
- Defined in source/List.ts:207

`Protected` loadNewPage

loadNewPage(pageIndex, pageSize, filter): Promise<{
pageData: D[];
totalCount: number;
}>
Protected
Parameters
- pageIndex: number
- pageSize: number
- filter: F
Returns Promise<{
pageData: D[];
totalCount: number;
}>
- Defined in source/List.ts:143

`Abstract` `Protected` loadPage

loadPage(pageIndex, pageSize, filter): Promise<PageData<D>>
Protected
Parameters
- pageIndex: number
- pageSize: number
- filter: F
Returns Promise<PageData<D>>
- Defined in source/List.ts:134

refreshList

refreshList(): Promise<D[]>
Returns Promise<D[]>
- Defined in source/List.ts:179

removeOne

removeOne(id): Promise<void>
Parameters
- id: IDType
Returns Promise<void>
- Defined in source/List.ts:237

restoreList

restoreList(__namedParameters?): void
Parameters
- __namedParameters: Partial<Pick<ListModel<D, Partial<NewData<D>>>, "pageIndex" | "pageSize" | "totalCount" | "allItems">> = {}
Returns void
- Defined in source/List.ts:103

turnTo

turnTo(pageIndex, pageSize?): ListModel<D, F>
Parameters
- pageIndex: number
- pageSize: number = ...
Returns ListModel<D, F>
- Defined in source/List.ts:120

updateOne

updateOne(data, id?): Promise<D>
Parameters
- data: Partial<NewData<D>>
- Optional id: IDType
Returns Promise<D>
Overrides BaseListModel.updateOne
- Defined in source/List.ts:229

`Static` createNested

createNested(parentId): BaseListModel<{}>
Parameters
- parentId: IDType
Returns BaseListModel<{}>
Inherited from BaseListModel.createNested
- Defined in source/Base.ts:49

Class ListModel<D, F>Abstract

Type Parameters

D extends DataObject

F extends Filter<D> = Filter<D>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

D extends DataObject

F extends Partial<NewData<D>> = Partial<NewData<D>>

Returns ListModel<D, F>

Properties

Abstract baseURI

Abstract client

currentOne

downloading

filter

indexKey

pageIndex

pageList

pageSize

statistic

Optional totalCount

uploading

validity

Accessors

allItems

Returns D[]

currentPage

Returns D[]

noMore

Returns boolean

pageCount

Returns number

Methods

changeOne

Parameters

data: Partial<D>

id: IDType

patch: boolean = false

Returns void

clear

Returns void

clearCurrent

Returns void

clearList

Returns void

countAll

Parameters

keys: TypeKeys<D, IndexKey>[]

filter: F = ...

pageSize: number = ...

Returns Promise<Partial<Record<TypeKeys<D, IndexKey>, Record<string, number>>>>

deleteOne

Parameters

id: IDType

Returns Promise<void>

getAll

Parameters

filter: F = ...

pageSize: number = ...

Returns Promise<D[]>

getList

Parameters

filter: F = ...

pageIndex: number = ...

pageSize: number = ...

Returns Promise<D[]>

getOne

Parameters

id: IDType

Returns Promise<D>

indexOf

Parameters

id: IDType

Class ListModel<D, F>`Abstract`

`Abstract` baseURI

`Abstract` client

`Optional` totalCount

`Protected` loadNewPage

Returns Promise<{
pageData: D[];
totalCount: number;
}>

`Abstract` `Protected` loadPage

`Optional` id: IDType

`Static` createNested