Class BaseListModel<D>`Abstract`

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

Type Parameters

D extends DataObject

Hierarchy

BaseModel
- BaseListModel
  - ListModel

Index

Constructors

Properties

baseURI client currentOne downloading indexKey uploading validity

Methods

clear clearCurrent deleteOne getOne updateOne createNested

Constructors

constructor

new BaseListModel<D>(): BaseListModel<D>
Type Parameters
- D extends DataObject
Returns BaseListModel<D>
Overrides BaseModel.constructor
- Defined in source/Base.ts:34

Properties

`Abstract` baseURI

baseURI: string

`Abstract` client

client: RESTClient

currentOne

currentOne: D = ...

downloading

downloading: number = 0

indexKey

indexKey: keyof D = 'id'

uploading

uploading: number = 0

validity

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

Methods

clear

clear(): void
Returns void
Overrides BaseModel.clear
- Defined in source/Base.ts:65

clearCurrent

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

deleteOne

deleteOne(id): Promise<void>
Parameters
- id: IDType
Returns Promise<void>
- Defined in source/Base.ts:87

getOne

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

updateOne

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

`Static` createNested

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

Generated using TypeDoc