filterable-set - v0.1.5 › Globals › FilterableSet
▪ T
▪ T
▪ T
-
↳ FilterableSet
- [Symbol.iterator]
- add
- addAddFilter
- addDeleteFilter
- addForce
- clear
- delete
- deleteAddFilter
- deleteDeleteFilter
- deleteForce
- entries
- forEach
- has
- isAddLocked
- isAllLocked
- isDeleteLocked
- keys
- lockAdd
- lockAll
- lockDelete
- resetAddFilters
- resetDeleteFilters
- resetFilters
- unlockAdd
- unlockAll
- unlockDelete
- values
+ new FilterableSet(initialValues?: any): FilterableSet
Defined in src/FilterableSet.ts:5
Create FilterableSet instance like Set
Parameters:
| Name | Type | Description |
|---|---|---|
initialValues? |
any | Added all iterable element to FilterableSet |
Returns: FilterableSet
• [Symbol.toStringTag]: string
Inherited from FilterableSet.[Symbol.toStringTag]
Defined in node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:138
• size: number
Inherited from FilterableSet.size
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:64
▪ Set: SetConstructor
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:71
▸ [Symbol.iterator](): IterableIterator‹T›
Inherited from FilterableSet.[Symbol.iterator]
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:171
Iterates over values in the set.
Returns: IterableIterator‹T›
▸ add(value: any): this
Overrides void
Defined in src/FilterableSet.ts:166
Parameters:
| Name | Type |
|---|---|
value |
any |
Returns: this
▸ addAddFilter(...fns: function[]): void
Defined in src/FilterableSet.ts:25
Add addFilters you want to, The registered filter is used as a verification function when call the filterableSet.add() or relative method to determine whether to add data.
Parameters:
| Name | Type | Description |
|---|---|---|
...fns |
function[] | addFilters you want to add |
Returns: void
▸ addDeleteFilter(...fns: function[]): void
Defined in src/FilterableSet.ts:45
Add deleteFilters you want to, The registered filter is used as a verification function when call the filterableSet.delete() or relative method to determine whether to delete data.
Parameters:
| Name | Type | Description |
|---|---|---|
...fns |
function[] | deleteFilters you want to add |
Returns: void
▸ addForce(value: any): this
Defined in src/FilterableSet.ts:87
Addition always succeeds regardless of the add filters.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | value you want to add. |
Returns: this
▸ clear(): void
Inherited from FilterableSet.clear
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:60
Returns: void
▸ delete(value: any): boolean
Overrides void
Defined in src/FilterableSet.ts:181
Parameters:
| Name | Type |
|---|---|
value |
any |
Returns: boolean
▸ deleteAddFilter(fn: Function): boolean
Defined in src/FilterableSet.ts:36
Delete addFilters you want to
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
Function | function you want to delete |
Returns: boolean
- if delete success return true else return false
▸ deleteDeleteFilter(fn: Function): boolean
Defined in src/FilterableSet.ts:56
Delete deleteFilters you want to
Parameters:
| Name | Type | Description |
|---|---|---|
fn |
Function | function you want to delete |
Returns: boolean
- if delete success return true else return false
▸ deleteForce(value: any): boolean
Defined in src/FilterableSet.ts:96
Deletion always succeeds regardless of the delete filters.
Parameters:
| Name | Type | Description |
|---|---|---|
value |
any | value you want to delete. |
Returns: boolean
▸ entries(): IterableIterator‹[T, T]›
Inherited from FilterableSet.entries
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:175
Returns an iterable of [v,v] pairs for every value v in the set.
Returns: IterableIterator‹[T, T]›
▸ forEach(callbackfn: function, thisArg?: any): void
Inherited from FilterableSet.forEach
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:62
Parameters:
▪ callbackfn: function
▸ (value: T, value2: T, set: Set‹T›): void
Parameters:
| Name | Type |
|---|---|
value |
T |
value2 |
T |
set |
Set‹T› |
▪Optional thisArg: any
Returns: void
▸ has(value: T): boolean
Inherited from FilterableSet.has
Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:63
Parameters:
| Name | Type |
|---|---|
value |
T |
Returns: boolean
▸ isAddLocked(): boolean
Defined in src/FilterableSet.ts:103
Return value is add-lock lock status, true is locked
Returns: boolean
▸ isAllLocked(): boolean
Defined in src/FilterableSet.ts:117
Return true if add-lock and delete-lock are locked all
Returns: boolean
▸ isDeleteLocked(): boolean
Defined in src/FilterableSet.ts:110
Return value is delete-lock lock status, true is locked
Returns: boolean
▸ keys(): IterableIterator‹T›
Inherited from FilterableSet.keys
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:179
Despite its name, returns an iterable of the values in the set,
Returns: IterableIterator‹T›
▸ lockAdd(): void
Defined in src/FilterableSet.ts:124
It is never added regardless of the add filters.
Returns: void
▸ lockAll(): void
Defined in src/FilterableSet.ts:152
It is same with lockAdd() and lockDelete()
Returns: void
▸ lockDelete(): void
Defined in src/FilterableSet.ts:138
It is never deleted regardless of the delete filters.
Returns: void
▸ resetAddFilters(): void
Defined in src/FilterableSet.ts:63
Reset added addFilters
Returns: void
▸ resetDeleteFilters(): void
Defined in src/FilterableSet.ts:70
Reset added deleteFilters
Returns: void
▸ resetFilters(): void
Defined in src/FilterableSet.ts:77
Reset added both addFilters and deleteFilters
Returns: void
▸ unlockAdd(): void
Defined in src/FilterableSet.ts:131
Unlock the add-lock, now addFilters are applied.
Returns: void
▸ unlockAll(): void
Defined in src/FilterableSet.ts:160
It is same with unlockAdd() and unlockDelete()
Returns: void
▸ unlockDelete(): void
Defined in src/FilterableSet.ts:145
Unlock the delete-lock, now deleteFilters are applied.
Returns: void
▸ values(): IterableIterator‹T›
Inherited from FilterableSet.values
Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:184
Returns an iterable of values in the set.
Returns: IterableIterator‹T›