Class CoreList<M, E>`Abstract`

Type Parameters

M extends object = object
E extends string = never

Hierarchy

Core<E | CoreListEventType>
- CoreList

Implements

IList<M>

Index

Constructors

constructor

new CoreList<M, E>(items?: M[]): CoreList<M, E>
Type Parameters
- M extends object = object
- E extends string = never
Parameters
- Optional items: M[]
Returns CoreList<M, E>
Overrides Core.constructor
- Defined in src/model/basic/CoreList.class.ts:21

Properties

`Readonly` $$isEmitter

$$isEmitter: true

`Readonly` index

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

`Protected` isBatching

isBatching: boolean = false

`Abstract` itemKey

itemKey: string

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
- 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 Core.$set
- Defined in src/model/basic/Core.class.ts:7

[iterator]

[iterator](): Generator<M, void, unknown>
Returns Generator<M, void, unknown>
Implementation of IList.__@iterator@1048
- Defined in src/model/basic/CoreList.class.ts:15

`Protected` _add

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

`Protected` _clear

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

`Protected` _remove

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

add

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

addArr

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

addRange

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

clear

clear(): void
Returns void
Implementation of IList.clear
- Defined in src/model/basic/CoreList.class.ts:127

`Abstract` create

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

filter

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

find

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

fire

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

fire$n

fire$n(event: string, payload?: PlainObject): CoreList<M, E>
split fire
Parameters
- event: string
- Optional payload: PlainObject
Returns CoreList<M, E>
Inherited from Core.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
- Defined in src/model/basic/CoreList.class.ts:170

has

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

listen

listen<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): CoreList<M, E>
on
Type Parameters
- T extends string
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 CoreList<M, E>
Inherited from Core.listen
- Defined in src/model/basic/Emitter.ts:155

listen$1

listen$1<T>(event: T, fn: ((event: WikEvent<any, any>) => void), context?: any): CoreList<M, E>
once
Type Parameters
- T extends string
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 CoreList<M, E>
Inherited from Core.listen$1
- Defined in src/model/basic/Emitter.ts:172

listen$n

listen$n(event: string, fn: ((event: WikEvent<any, any>) => void)): CoreList<M, E>
split on
Parameters
- event: string
- fn: ((event: WikEvent<any, any>) => void)
  - - (event: WikEvent<any, any>): void
    - Parameters
      
      event: WikEvent<any, any>
      
      Returns void
Returns CoreList<M, E>
Inherited from Core.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[]
Implementation of IList.map
- Defined in src/model/basic/CoreList.class.ts:199

onClear

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

onItemAdd

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

onItemRemove

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

onItemUpdate

onItemUpdate(item: M, data: any): void
Parameters
- item: M
- data: any
Returns void
- 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[]
Implementation of IList.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 Core.readOnly
- Defined in src/model/basic/Core.class.ts:22

remove

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

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

removeArr

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

removeById

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

removeRange

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

setEventChild

setEventChild(child: WithEmitter<string>, off?: boolean): CoreList<M, E>
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 CoreList<M, E>
Inherited from Core.setEventChild
- Defined in src/model/basic/Emitter.ts:178

setEventParent

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

unlisten

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

unlisten$n

unlisten$n(event: string, fn?: ((event: WikEvent<any, any>) => void)): CoreList<M, E>
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 CoreList<M, E>
Inherited from Core.unlisten$n
- Defined in src/model/basic/Emitter.ts:167

update

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

updateRange

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

Generated using TypeDoc