Class ListModel<D, F>Abstract

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>

[asyncIterator]

allItems

• get allItems(): D[]

  Returns D[]

currentPage

• get currentPage(): D[]

  Returns D[]

filter

noMore

• get noMore(): boolean

  Returns boolean

pageCount

• get pageCount(): number

  Returns number

pageIndex

pageList

pageSize

statistic

totalCount

changeOne

• changeOne(data: Partial<D>, id: IDType, patch?: boolean): void

  Parameters

  • data: Partial<D>
  • id: IDType
  • patch: boolean = false

  Returns void

clear

• clear(): void

  Returns void

clearList

• clearList(): void

  Returns void

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>>>>

deleteOne

• deleteOne(id: IDType): Promise<void>

  Parameters

  • id: IDType

  Returns Promise<void>

getAll

• getAll(filter?: F, pageSize?: number): Promise<D[]>

  Parameters

  • filter: F = ...
  • pageSize: number = ...

  Returns Promise<D[]>

getAllInStream

• getAllInStream(filter?: F, pageSize?: number): AsyncGenerator<D, void, unknown>

  Parameters

  • filter: F = ...
  • pageSize: number = ...

  Returns AsyncGenerator<D, void, unknown>

getList

• getList(filter?: F, pageIndex?: number, pageSize?: number): Promise<D[]>

  Parameters

  • filter: F = ...
  • pageIndex: number = ...
  • pageSize: number = ...

  Returns Promise<D[]>

indexOf

• indexOf(id: IDType): number

  Parameters

  • id: IDType

  Returns number

refreshList

• refreshList(): Promise<D[]>

  Returns Promise<D[]>

removeOne

• removeOne(id: IDType): Promise<void>

  Parameters

  • id: IDType

  Returns Promise<void>

restoreList

• restoreList(
      __namedParameters?: Partial<
          Pick<
              ListModel<D>,
              "pageIndex" | "pageSize" | "allItems" | "totalCount",
          >,
      >,
  ): void

  Parameters

  • __namedParameters: Partial<
        Pick<ListModel<D>, "pageIndex" | "pageSize" | "allItems" | "totalCount">,
    > = {}

  Returns void

turnTo

• turnTo(pageIndex: number, pageSize?: number): ListModel<D, F>

  Parameters

  • pageIndex: number
  • pageSize: number = ...

  Returns ListModel<D, F>

updateOne

• updateOne(data: Partial<NewData<D>>, id?: IDType): Promise<D>

  Parameters

  • data: Partial<NewData<D>>
  • Optionalid: IDType

  Returns Promise<D>