Class: SavedSearch

Defined in: Data/Models/Main/SavedSearch.ts:53

Constructors

Constructor

new SavedSearch(data): SavedSearch

Defined in: Data/Models/Main/SavedSearch.ts:65

Parameters

data

createdDate?

string

lastUsed?

string

metadata?

Record<string, any>

name

string

options

SearchOptions

query

string

scope

SearchScopeData

searchId?

number

searchType

"boolean" | "strongs" | "multi-word" | "phrase" | "proximity" | "verse-proximity" | "fuzzy" | "regex"

useCount?

number

Returns

SavedSearch

Properties

createdDate?

optional createdDate?: string

Defined in: Data/Models/Main/SavedSearch.ts:60

---

lastUsed?

optional lastUsed?: string

Defined in: Data/Models/Main/SavedSearch.ts:61

---

metadata?

optional metadata?: Record<string, any>

Defined in: Data/Models/Main/SavedSearch.ts:63

---

name

name: string

Defined in: Data/Models/Main/SavedSearch.ts:55

---

options

options: SearchOptions

Defined in: Data/Models/Main/SavedSearch.ts:59

---

query

query: string

Defined in: Data/Models/Main/SavedSearch.ts:56

---

scope

scope: SearchScopeData

Defined in: Data/Models/Main/SavedSearch.ts:58

---

searchId?

optional searchId?: number

Defined in: Data/Models/Main/SavedSearch.ts:54

---

searchType

searchType: "boolean" | "strongs" | "multi-word" | "phrase" | "proximity" | "verse-proximity" | "fuzzy" | "regex"

Defined in: Data/Models/Main/SavedSearch.ts:57

---

useCount

useCount: number

Defined in: Data/Models/Main/SavedSearch.ts:62

Methods

clone()

clone(newName): SavedSearch

Defined in: Data/Models/Main/SavedSearch.ts:111

Clone this search with a new name

Parameters

newName

string

Returns

SavedSearch

---

getDescription()

getDescription(): string

Defined in: Data/Models/Main/SavedSearch.ts:100

Get a display-friendly description of the search

Returns

string

---

markAsUsed()

markAsUsed(): void

Defined in: Data/Models/Main/SavedSearch.ts:92

Mark this search as used (updates lastUsed and increments useCount)

Returns

void

---

toJSON()

toJSON(): Record<string, any>

Defined in: Data/Models/Main/SavedSearch.ts:126

Export to JSON for storage

Returns

Record<string, any>

---

fromJSON()

static fromJSON(json): SavedSearch

Defined in: Data/Models/Main/SavedSearch.ts:144

Create from JSON

Parameters

json

Record<string, any>

Returns

SavedSearch