Skip to content

baseindex.md

Latest commit

 

History

History
407 lines (231 loc) · 6.28 KB

baseindex.md

File metadata and controls

407 lines (231 loc) · 6.28 KB
id BaseIndex
title BaseIndex

Class: abstract BaseIndex<TKey>

Defined in: packages/db/src/indexes/base-index.ts:28

Base abstract class that all index types extend

Extended by

Type Parameters

• TKey extends string | number = string | number

Constructors

new BaseIndex()

new BaseIndex<TKey>(
   id, 
   expression, 
   name?, 
options?): BaseIndex<TKey>

Defined in: packages/db/src/indexes/base-index.ts:40

Parameters

id

number

expression

BasicExpression

name?

string

options?

any

Returns

BaseIndex<TKey>

Properties

expression

readonly expression: BasicExpression;

Defined in: packages/db/src/indexes/base-index.ts:33

id

readonly id: number;

Defined in: packages/db/src/indexes/base-index.ts:31

lastUpdated

protected lastUpdated: Date;

Defined in: packages/db/src/indexes/base-index.ts:38

lookupCount

protected lookupCount: number = 0;

Defined in: packages/db/src/indexes/base-index.ts:36

name?

readonly optional name: string;

Defined in: packages/db/src/indexes/base-index.ts:32

supportedOperations

abstract readonly supportedOperations: Set<"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike">;

Defined in: packages/db/src/indexes/base-index.ts:34

totalLookupTime

protected totalLookupTime: number = 0;

Defined in: packages/db/src/indexes/base-index.ts:37

Accessors

keyCount

Get Signature

get abstract keyCount(): number

Defined in: packages/db/src/indexes/base-index.ts:59

Returns

number

Methods

add()

abstract add(key, item): void

Defined in: packages/db/src/indexes/base-index.ts:53

Parameters

key

TKey

item

any

Returns

void

build()

abstract build(entries): void

Defined in: packages/db/src/indexes/base-index.ts:56

Parameters

entries

Iterable<[TKey, any]>

Returns

void

clear()

abstract clear(): void

Defined in: packages/db/src/indexes/base-index.ts:57

Returns

void

evaluateIndexExpression()

protected evaluateIndexExpression(item): any

Defined in: packages/db/src/indexes/base-index.ts:87

Parameters

item

any

Returns

any

getStats()

getStats(): IndexStats

Defined in: packages/db/src/indexes/base-index.ts:74

Returns

IndexStats

initialize()

abstract protected initialize(options?): void

Defined in: packages/db/src/indexes/base-index.ts:85

Parameters

options?

any

Returns

void

lookup()

abstract lookup(operation, value): Set<TKey>

Defined in: packages/db/src/indexes/base-index.ts:58

Parameters

operation

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

value

any

Returns

Set<TKey>

matchesField()

matchesField(fieldPath): boolean

Defined in: packages/db/src/indexes/base-index.ts:66

Parameters

fieldPath

string[]

Returns

boolean

remove()

abstract remove(key, item): void

Defined in: packages/db/src/indexes/base-index.ts:54

Parameters

key

TKey

item

any

Returns

void

supports()

supports(operation): boolean

Defined in: packages/db/src/indexes/base-index.ts:62

Parameters

operation

"eq" | "gt" | "gte" | "lt" | "lte" | "in" | "like" | "ilike"

Returns

boolean

trackLookup()

protected trackLookup(startTime): void

Defined in: packages/db/src/indexes/base-index.ts:92

Parameters

startTime

number

Returns

void

update()

abstract update(
   key, 
   oldItem, 
   newItem): void

Defined in: packages/db/src/indexes/base-index.ts:55

Parameters

key

TKey

oldItem

any

newItem

any

Returns

void

updateTimestamp()

protected updateTimestamp(): void

Defined in: packages/db/src/indexes/base-index.ts:98

Returns

void