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 (View Summary, Expand)

BaseListModel<D>
- ListModel

Index

Constructors

Properties

baseURI client indexKey

Accessors

allItems currentOne currentPage downloading filter noMore pageCount pageIndex pageList pageSize statistic totalCount uploading

Methods

changeOne clear clearCurrent clearList countAll deleteOne getAll getList getOne indexOf loadNewPage loadPage refreshList removeOne restoreList turnTo updateOne createNested

Constructors

constructor

new ListModel<
D extends DataObject,
F extends Partial<NewData<D>> = Partial<NewData<D>>,
>(): ListModel<D, F>
Type Parameters
- D extends DataObject
- F extends Partial<NewData<D>> = Partial<NewData<D>>
Returns ListModel<D, F>
Inherited from BaseListModel.constructor

Properties

`Abstract`baseURI

baseURI: string

`Abstract`client

client: RESTClient

indexKey

indexKey: keyof D = 'id'

Accessors

allItems

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

currentOne

currentOne: any

currentPage

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

downloading

downloading: any

filter

filter: any

noMore

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

pageCount

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

pageIndex

pageIndex: any

pageList

pageList: any

pageSize

pageSize: any

statistic

statistic: any

totalCount

totalCount: any

uploading

uploading: any

Methods

changeOne

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

clear

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

clearCurrent

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

clearList

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

countAll

countAll(
    keys: TypeKeys<D, IndexKey>[],
    filter?: F,
    pageSize?: number,
): 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:190

deleteOne

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

getAll

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

getList

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

getOne

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

indexOf

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

`Protected`loadNewPage

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

`Protected` `Abstract`loadPage

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

refreshList

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

removeOne

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

restoreList

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

turnTo

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

updateOne

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

`Static`createNested

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