Globals / "src/common/search-store" / SearchStore
Class: SearchStore#
Hierarchy#
- SearchStore
Index#
Properties#
Accessors#
Methods#
- escapeRegex
- findOccurences
- getNextOverlay
- getPrevOverlay
- isActiveOverlay
- onSearch
- reset
- setNextOverlayActive
- setPrevOverlayActive
Properties#
activeOverlayIndex#
• activeOverlayIndex: number = -1
Defined in src/common/search-store.ts:7
occurrences#
• occurrences: number[] = []
Defined in src/common/search-store.ts:6
searchQuery#
• searchQuery: string = ""
Defined in src/common/search-store.ts:5
Accessors#
activeFind#
• get activeFind(): number
Defined in src/common/search-store.ts:91
Returns: number
activeOverlayLine#
• get activeOverlayLine(): number
Defined in src/common/search-store.ts:87
Gets line index of where active overlay is located
Returns: number
A line index within the text/logs array
totalFinds#
• get totalFinds(): number
Defined in src/common/search-store.ts:95
Returns: number
Methods#
escapeRegex#
▸ escapeRegex(value: string): string
Defined in src/common/search-store.ts:114
An utility methods escaping user string to safely pass it into new Regex(variable)
Parameters:
| Name | Type | Description |
|---|---|---|
value |
string | Unescaped string |
Returns: string
findOccurences#
▸ findOccurences(text: string[], query: string): number[]
Defined in src/common/search-store.ts:36
Does searching within text array, create a list of search keyword occurences. Each keyword "occurency" is saved as index of the the line where keyword founded
Parameters:
| Name | Type | Description |
|---|---|---|
text |
string[] | An array of any textual data (logs, for example) |
query |
string | Search query from input |
Returns: number[]
Array of line indexes [0, 0, 14, 17, 17, 17, 20...]
getNextOverlay#
▸ getNextOverlay(loopOver?: boolean): number
Defined in src/common/search-store.ts:52
Getting next overlay index within the occurences array
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
loopOver |
boolean | false | Allows to jump from last element to first |
Returns: number
next overlay index
getPrevOverlay#
▸ getPrevOverlay(loopOver?: boolean): number
Defined in src/common/search-store.ts:65
Getting previous overlay index within the occurences array of occurences
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
loopOver |
boolean | false | Allows to jump from first element to last one |
Returns: number
prev overlay index
isActiveOverlay#
▸ isActiveOverlay(line: number, occurence: number): boolean
Defined in src/common/search-store.ts:105
Checks if overlay is active (to highlight it with orange background usually)
Parameters:
| Name | Type | Description |
|---|---|---|
line |
number | Index of the line where overlay is located |
occurence |
number | Number of the overlay within one line |
Returns: boolean
onSearch#
▸ onSearch(text: string[], query?: string): void
Defined in src/common/search-store.ts:15
Sets default activeOverlayIndex
Parameters:
| Name | Type | Default value | Description |
|---|---|---|---|
text |
string[] | - | An array of any textual data (logs, for example) |
query |
string | this.searchQuery | Search query from input |
Returns: void
reset#
▸ reset(): void
Defined in src/common/search-store.ts:119
Returns: void
setNextOverlayActive#
▸ setNextOverlayActive(): void
Defined in src/common/search-store.ts:74
Returns: void
setPrevOverlayActive#
▸ setPrevOverlayActive(): void
Defined in src/common/search-store.ts:79
Returns: void