Class List<M>

List for holding Base. events: add,remove,update,add.r,remove.r,update.r

Type Parameters

M extends Base

Hierarchy

CoreList<M>
- List

Implements

Serializable

Index

Constructors

constructor

new List<M>(C: ConstructorOrFactory<M>, items: M[]): List<M>
Type Parameters
- M extends Base<string, M>
Parameters
- C: ConstructorOrFactory<M>
- items: M[]
Returns List<M>
Overrides CoreList.constructor
- Defined in src/model/basic/List.class.ts:23

Properties

`Readonly` $$isEmitter

$$isEmitter: true

`Readonly` index

index: Map<string, M> = ...

`Protected` isBatching

isBatching: boolean = false

`Private` itemC

itemC: ConstructorOrFactory<M> = null

`Readonly` itemKey

itemKey: string = 'id'

key to item.

`Readonly` items

items: Set<M> = ...

noEmit

noEmit: boolean

set it True, the follow emit will be ignore and then set it False.

size

size: number = 0

Methods

$has

$has(predicate: ((item: M) => boolean)): boolean
Parameters
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns boolean
Inherited from CoreList.$has
- Defined in src/model/basic/CoreList.class.ts:207

$set

$set(pairs: string | Record<string, any>, value?: any, context?: object): void
Parameters
- pairs: string | Record<string, any>
- Optional value: any
- Optional context: object
Returns void
Inherited from CoreList.$set
- Defined in src/model/basic/Core.class.ts:7

[iterator]

[iterator](): Generator<M, void, unknown>
Returns Generator<M, void, unknown>
Overrides CoreList.[iterator]
- Defined in src/model/basic/List.class.ts:17

_add

_add(item: M): void
Parameters
- item: M
Returns void
Overrides CoreList._add
- Defined in src/model/basic/List.class.ts:36

_clear

_clear(): void
Returns void
Overrides CoreList._clear
- Defined in src/model/basic/List.class.ts:46

_remove

_remove(item: M): void
Parameters
- item: M
Returns void
Overrides CoreList._remove
- Defined in src/model/basic/List.class.ts:41

add

add(item: M): void
将一个对象加入到数据集，标记为 Added，将在下次提交时远程添加
Parameters
- item: M
Returns void
Inherited from CoreList.add
- Defined in src/model/basic/CoreList.class.ts:30

addArr

addArr(items: M[]): void
Parameters
- items: M[]
Returns void
Inherited from CoreList.addArr
- Defined in src/model/basic/CoreList.class.ts:54

addRange

addRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from CoreList.addRange
- Defined in src/model/basic/CoreList.class.ts:50

clear

clear(): void
Returns void
Inherited from CoreList.clear
- Defined in src/model/basic/CoreList.class.ts:127

create

create(...args: any[]): M
创建一个默认的对象，并且将其添加至数据集
Parameters
- Rest ...args: any[]
Returns M
Overrides CoreList.create
- Defined in src/model/basic/List.class.ts:53

filter

filter(pipe: ((m: M) => boolean)): M[]
Parameters
- pipe: ((m: M) => boolean)
  - - (m: M): boolean
    - Parameters
      
      m: M
      
      Returns boolean
Returns M[]
Inherited from CoreList.filter
- Defined in src/model/basic/CoreList.class.ts:191

find

find(key: string): M
Parameters
- key: string
Returns M
Inherited from CoreList.find
- Defined in src/model/basic/CoreList.class.ts:159

fire

fire<T>(event: T, payload?: PlainObject): boolean
Type Parameters
- T extends CoreListEventType
Parameters
- event: T
- Optional payload: PlainObject
Returns boolean
Inherited from CoreList.fire
- Defined in src/model/basic/Emitter.ts:147

fire$n

fire$n(event: string, payload?: PlainObject): List<M>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns List<M>
Inherited from CoreList.fire$n
- Defined in src/model/basic/Emitter.ts:151

first

first(predicate?: ((item: M) => boolean)): M
Parameters
- Optional predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns M
Inherited from CoreList.first
- Defined in src/model/basic/CoreList.class.ts:170

fromJSON

fromJSON(data: any[]): List<M>
Parameters
- data: any[]
Returns List<M>
Implementation of Serializable.fromJSON
- Defined in src/model/basic/List.class.ts:28

has

has(key: string | M): boolean
查询
Parameters
- key: string | M
Returns boolean
Inherited from CoreList.has
- Defined in src/model/basic/CoreList.class.ts:149

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): List<M>
on
Type Parameters
- T extends CoreListEventType
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns List<M>
Inherited from CoreList.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): List<M>
once
Type Parameters
- T extends CoreListEventType
Parameters
- event: T
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
- Optional context: any
Returns List<M>
Inherited from CoreList.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): List<M>
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns List<M>
Inherited from CoreList.listen$n
- Defined in src/model/basic/Emitter.ts:159

map

map<R>(project: ((m: M) => R)): R[]
Type Parameters
- R
Parameters
- project: ((m: M) => R)
  - - (m: M): R
    - Parameters
      
      m: M
      
      Returns R
Returns R[]
Inherited from CoreList.map
- Defined in src/model/basic/CoreList.class.ts:199

onClear

onClear(): void
Returns void
Inherited from CoreList.onClear
- Defined in src/model/basic/CoreList.class.ts:227

onItemAdd

onItemAdd(item: M): void
Parameters
- item: M
Returns void
Inherited from CoreList.onItemAdd
- Defined in src/model/basic/CoreList.class.ts:224

onItemRemove

onItemRemove(item: M): void
Parameters
- item: M
Returns void
Inherited from CoreList.onItemRemove
- Defined in src/model/basic/CoreList.class.ts:225

onItemUpdate

onItemUpdate(item: M, data: any): void
Parameters
- item: M
- data: any
Returns void
Inherited from CoreList.onItemUpdate
- Defined in src/model/basic/CoreList.class.ts:226

query

query(predicate: ((item: M) => boolean)): M[]
Parameters
- predicate: ((item: M) => boolean)
  - - (item: M): boolean
    - Parameters
      
      item: M
      
      Returns boolean
Returns M[]
Inherited from CoreList.query
- Defined in src/model/basic/CoreList.class.ts:183

readOnly

readOnly<V>(key: string, value: V): void
Type Parameters
- V = any
Parameters
- key: string
- value: V
Returns void
Inherited from CoreList.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

remove(item?: M): void
将对象从数据集移除，并将其标记为 Deleted，将在下次提交时远程删除

Warn！当不传 item 的时候，表示移除全部元素
Parameters
- Optional item: M
Returns void
Inherited from CoreList.remove
- Defined in src/model/basic/CoreList.class.ts:67

removeArr

removeArr(items: M[]): void
Parameters
- items: M[]
Returns void
Inherited from CoreList.removeArr
- Defined in src/model/basic/CoreList.class.ts:114

removeById

removeById(key: string): void
Parameters
- key: string
Returns void
Inherited from CoreList.removeById
- Defined in src/model/basic/CoreList.class.ts:97

removeRange

removeRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from CoreList.removeRange
- Defined in src/model/basic/CoreList.class.ts:110

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): List<M>
Create parent-child relationships of two evented objects manually. Because this method not mounted on evented object.
Parameters
- child: WithEmitter<string>
- Optional off: boolean
Returns List<M>
Inherited from CoreList.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

setEventParent(parent: WithEmitter<string>): List<M>
Parameters
- parent: WithEmitter<string>
Returns List<M>
Inherited from CoreList.setEventParent
- Defined in src/model/basic/Emitter.ts:180

toJSON

toJSON(): void
Returns void
Implementation of Serializable.toJSON
- Defined in src/model/basic/List.class.ts:32

unlisten

unlisten<T>(event: T, fn?: ((event: WikEvent<any, any>) => void)): List<M>
off
Type Parameters
- T extends CoreListEventType
Parameters
- event: T
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns List<M>
Inherited from CoreList.unlisten
- Defined in src/model/basic/Emitter.ts:163

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): List<M>
split off
Parameters
- event: string
- Optional fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns List<M>
Inherited from CoreList.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

update

update(item: M): void
将对象标记为 Modified，将在下次提交时更新对应的远程对象
Parameters
- item: M
Returns void
Inherited from CoreList.update
- Defined in src/model/basic/CoreList.class.ts:141

updateRange

updateRange(...items: M[]): void
Parameters
- Rest ...items: M[]
Returns void
Inherited from CoreList.updateRange
- Defined in src/model/basic/CoreList.class.ts:145

Class List<M>

Type Parameters

M extends Base

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

M extends Base<string, M>

Parameters

C: ConstructorOrFactory<M>

items: M[]

Returns List<M>

Properties

Readonly $$isEmitter

Readonly index

Protected isBatching

Private itemC

Readonly itemKey

Readonly items

noEmit

size

Methods

$has

Parameters

predicate: ((item: M) => boolean)

Parameters

item: M

Returns boolean

Returns boolean

$set

Parameters

pairs: string | Record<string, any>

Optional value: any

Optional context: object

Returns void

[iterator]

Returns Generator<M, void, unknown>

_add

Parameters

item: M

Returns void

_clear

Returns void

_remove

Parameters

item: M

Returns void

add

Parameters

item: M

Returns void

addArr

Parameters

items: M[]

Returns void

addRange

Parameters

Rest ...items: M[]

Returns void

clear

Returns void

create

Parameters

Rest ...args: any[]

Returns M

filter

Parameters

pipe: ((m: M) => boolean)

Parameters

m: M

Returns boolean

Returns M[]

find

Parameters

key: string

`Readonly` $$isEmitter

`Readonly` index

`Protected` isBatching

`Private` itemC

`Readonly` itemKey

`Readonly` items

`Optional` value: any

`Optional` context: object

`Rest` ...items: M[]

`Rest` ...args: any[]

`Optional` payload: PlainObject

`Optional` payload: PlainObject

`Optional` predicate: ((item: M) => boolean)

`Optional` context: any

`Optional` context: any