Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ZlCollection<T>

混合型存储数据的集合 1.可以key:value对的形式获取和保存数据 2.支持用数字型索引获取和保存数据

Type parameters

  • T

Hierarchy

  • ZlCollection

Index

Constructors

Properties

Methods

Constructors

constructor

  • Type parameters

    • T

    Parameters

    • Optional keyFn: Function

      获取元素id的函数

    Returns ZlCollection<T>

Properties

allowFunctions

allowFunctions: boolean = false

确定是否可以包含函数元素

items

items: T[] = ...

数据

keys

keys: any[] = ...

length

length: number = 0

总数

map

map: object = ...

增加了key做索引的items 数据

Methods

_sort

  • 排序

    Parameters

    • property: string

      字段名

    • dir: FieldSortDirection

      方向

    • fn: (a: any, b: any) => number

      回调函数

        • (a: any, b: any): number

        • Parameters

          • a: any
          • b: any

          Returns number

    Returns void

add

  • add(key: any, item?: T): any

  • 增加元素

    注意参数的数量

    Parameters

    • key: any

      等于id

    • Optional item: T

      元素值

    Returns any

addAll

  • addAll(items: any): void

  • 批量增加元素 注意参数的数量

    Parameters

    • items: any

      元素数数组

    Returns void

clear

  • clear(): void

  • 清除集合内所有的数据

    Returns void

clone

  • 浅克隆数据

    Returns ZlCollection<T>

contains

  • contains(o: any): boolean

  • 判断集合是否包含元素

    Parameters

    • o: any

      需要判断的对象实例

    Returns boolean

    存在返回 true, 否则返回 false

containsKey

  • containsKey(key: any): boolean

  • 判断集合内是否包含key

    Parameters

    • key: any

      需要判断的ke

    Returns boolean

    存在返回 true, 否则返回 false

createValueMatcher

  • createValueMatcher(value: any, anyMatch: boolean, caseSensitive: boolean): string | RegExp

  • 创建一个处理value 的 匹配器

    Parameters

    • value: any
    • anyMatch: boolean

      正则匹配所有字符, 否则匹配以什么开头.

    • caseSensitive: boolean

      区分大小写

    Returns string | RegExp

    返回处理后的字符串或者正则对象

each

  • each(fn: Function, scope: any): void

  • Parameters

    • fn: Function
    • scope: any

    Returns void

eachKey

  • eachKey(fn: Function, scope: any): void

  • Parameters

    • fn: Function
    • scope: any

    Returns void

escapeRe

  • escapeRe(s: string): string

  • 处理特殊字符

    Parameters

    • s: string

      处理特殊字符 [.*+?^${}()|[]

    Returns string

    返回替换以后的字符串

filter

  • filter(property: any, value: any, anyMatch: any, caseSensitive: any): ZlCollection<T>

  • 过滤

    Parameters

    • property: any

      字段名称

    • value: any

      过滤的值

    • anyMatch: any

      正则匹配所有字符, 否则匹配以什么开头.

    • caseSensitive: any

      大小写敏感否

    Returns ZlCollection<T>

filterBy

  • 过滤比较函数

    Parameters

    • fn: any
    • scope: any

    Returns ZlCollection<T>

find

  • find(fn: Function, scope: any): T

  • Parameters

    • fn: Function
    • scope: any

    Returns T

findIndex

  • findIndex(property: string, value: string | RegExp, start: number, anyMatch: boolean, caseSensitive: boolean): number

  • 查找

    Parameters

    • property: string

      字段名称

    • value: string | RegExp

      查找的值

    • start: number

      开始位置

    • anyMatch: boolean

      正则匹配所有字符, 否则匹配以什么开头.

    • caseSensitive: boolean

      大小写敏感

    Returns number

    返回找到的记录index 否则返回-1

findIndexBy

  • findIndexBy(fn: BooleanFunction, scope: any, start: number): number

  • 查找记录比较函数

    Parameters

    • fn: BooleanFunction

      查找的对比函数

    • scope: any

      范围

    • start: number

    Returns number

    返回找到的记录index 否则返回-1

first

  • first(): T

  • 获取集合内第一个元素

    Returns T

    返回对应的元素

getCount

  • getCount(): number

  • 返回总数量

    Returns number

getKey

  • getKey(item?: T): any

  • 获取唯一主键的值

    Parameters

    • Optional item: T

    Returns any

getRange

  • getRange(start: number, end: number): T[]

  • 获取指定位置范围内的元素数组

    Parameters

    • start: number

      开始位置

    • end: number

      结束位置

    Returns T[]

    范围内的元素数组

indexOf

  • indexOf(o: any): number

  • 通过某个元素返回元素的位置index

    Parameters

    • o: any

      元素

    Returns number

indexOfKey

  • indexOfKey(key: any): number

  • 通过某个key返回key的位置index

    Parameters

    • key: any

    Returns number

insert

  • insert(index: number, item: any): any

  • 插入元素对象

    Parameters

    • index: number

      位置

    • item: any

      元素对象

    Returns any

    返回对象

isEmpty

  • isEmpty(value: any, allowBlank?: boolean): boolean

  • 判断value 是否为空

    Parameters

    • value: any

      需要判断的值

    • Optional allowBlank: boolean

      (可选)返回true，如果一个空字符串不被认为是空

    Returns boolean

    true 空 则反回false

item

  • item(key: any): T

  • 通过某个key返回元素

    Parameters

    • key: any

      元素的的key

    Returns T

itemAt

  • itemAt(index: any): T

  • 根据元素的位置index返回元素

    Parameters

    • index: any

      元素的位置

    Returns T

    返回对应的元素

key

  • key(key: any): T

  • 返回元素的实例

    Parameters

    • key: any

      元素的key

    Returns T

    返回对应的元素

keySort

  • key排序

    Parameters

    • dir: FieldSortDirection

      方向

    • fn: (a: any, b: any) => number

      回调函数

        • (a: any, b: any): number

        • Parameters

          • a: any
          • b: any

          Returns number

    Returns void

last

  • last(): T

  • 获取集合内最后一个元素

    Returns T

    返回对应的元素

remove

  • remove(o: any): false | T

  • Parameters

    • o: any

    Returns false | T

removeAt

  • removeAt(index: number): false | T

  • Parameters

    • index: number

    Returns false | T

removeKey

  • removeKey(key: any): false | T

  • Parameters

    • key: any

    Returns false | T

replace

  • replace(key: any, item: T): any

  • 替换

    Parameters

    • key: any
    • item: T

    Returns any

sort

  • 排序

    Parameters

    • dir: FieldSortDirection

      方向

    • fn: (a: any, b: any) => number

      回调函数

        • (a: any, b: any): number

        • Parameters

          • a: any
          • b: any

          Returns number

    Returns void

Generated using TypeDoc