CatalogDB | plannable

Hierarchy

Dexie
- CatalogDB

Index

Interfaces

Constructors

constructor

Properties

Methods

Constructors

constructor

new CatalogDB(semester: SemesterJSON): CatalogDB

Overrides Dexie.__constructor
- Defined in src/data/CatalogDB.ts:24
Parameters
- semester: SemesterJSON
Returns CatalogDB

Properties

Collection

Collection<T, Key>: {}

Type parameters

Type declaration

and

and(filter: (x: T) => boolean): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:385
Parameters
- filter: (x: T) => boolean
 - - (x: T): boolean
 - Parameters
 - x: T
 Returns boolean
Returns Collection<T, Key>

clone

clone(props?: Object): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:386
Parameters
- Optional props: Object
Returns Collection<T, Key>

count

count(): Promise<number>
count<R>(thenShortcut: ThenShortcut<number, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:387
Returns Promise<number>
- Defined in node_modules/dexie/dist/dexie.d.ts:388
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<number, R>
Returns Promise<R>

delete

delete(): Promise<number>

- Defined in node_modules/dexie/dist/dexie.d.ts:416
Returns Promise<number>

distinct

distinct(): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:389
Returns Collection<T, Key>

each

each(callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:390
Parameters
- callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any
 - - (obj: T, cursor: { key: IndexableType; primaryKey: Key }): any
 - Parameters
 - obj: T
 - cursor: { key: IndexableType; primaryKey: Key }
 
 key: IndexableType
 
 primaryKey: Key
 Returns any
Returns Promise<void>

eachKey

eachKey(callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:391
Parameters
- callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any
 - - (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }): any
 - Parameters
 - key: IndexableType
 - cursor: { key: IndexableType; primaryKey: Key }
 
 key: IndexableType
 
 primaryKey: Key
 Returns any
Returns Promise<void>

eachPrimaryKey

eachPrimaryKey(callback: (key: Key, cursor: { key: IndexableType; primaryKey: Key }) => any): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:392
Parameters
- callback: (key: Key, cursor: { key: IndexableType; primaryKey: Key }) => any
 - - (key: Key, cursor: { key: IndexableType; primaryKey: Key }): any
 - Parameters
 - key: Key
 - cursor: { key: IndexableType; primaryKey: Key }
 
 key: IndexableType
 
 primaryKey: Key
 Returns any
Returns Promise<void>

eachUniqueKey

eachUniqueKey(callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:393
Parameters
- callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any
 - - (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }): any
 - Parameters
 - key: IndexableType
 - cursor: { key: IndexableType; primaryKey: Key }
 
 key: IndexableType
 
 primaryKey: Key
 Returns any
Returns Promise<void>

filter

filter(filter: (x: T) => boolean): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:394
Parameters
- filter: (x: T) => boolean
 - - (x: T): boolean
 - Parameters
 - x: T
 Returns boolean
Returns Collection<T, Key>

first

first(): Promise<T | undefined>
first<R>(thenShortcut: ThenShortcut<T | undefined, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:395
Returns Promise<T | undefined>
- Defined in node_modules/dexie/dist/dexie.d.ts:396
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<T | undefined, R>
Returns Promise<R>

keys

keys(): Promise<IndexableTypeArray>
keys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:397
Returns Promise<IndexableTypeArray>
- Defined in node_modules/dexie/dist/dexie.d.ts:398
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<IndexableTypeArray, R>
Returns Promise<R>

last

last(): Promise<T | undefined>
last<R>(thenShortcut: ThenShortcut<T | undefined, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:401
Returns Promise<T | undefined>
- Defined in node_modules/dexie/dist/dexie.d.ts:402
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<T | undefined, R>
Returns Promise<R>

limit

limit(n: number): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:403
Parameters
- n: number
Returns Collection<T, Key>

modify

modify(changeCallback: (obj: T, ctx: { value: T }) => void): Promise<number>
modify(changes: {}): Promise<number>

- Defined in node_modules/dexie/dist/dexie.d.ts:417
Parameters
- changeCallback: (obj: T, ctx: { value: T }) => void
 - - (obj: T, ctx: { value: T }): void
 - Parameters
 - obj: T
 - ctx: { value: T }
 
 value: T
 Returns void
Returns Promise<number>
- Defined in node_modules/dexie/dist/dexie.d.ts:418
Parameters
- changes: {}
 - [keyPath: string]: any
Returns Promise<number>

offset

offset(n: number): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:404
Parameters
- n: number
Returns Collection<T, Key>

or

or(indexOrPrimayKey: string): WhereClause<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:405
Parameters
- indexOrPrimayKey: string
Returns WhereClause<T, Key>

primaryKeys

primaryKeys(): Promise<Key[]>
primaryKeys<R>(thenShortcut: ThenShortcut<Key[], R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:399
Returns Promise<Key[]>
- Defined in node_modules/dexie/dist/dexie.d.ts:400
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<Key[], R>
Returns Promise<R>

raw

raw(): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:406
Returns Collection<T, Key>

reverse

reverse(): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:407
Returns Collection<T, Key>

sortBy

sortBy(keyPath: string): Promise<T[]>
sortBy<R>(keyPath: string, thenShortcut: ThenShortcut<T[], R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:408
Parameters
- keyPath: string
Returns Promise<T[]>
- Defined in node_modules/dexie/dist/dexie.d.ts:409
Type parameters
- R
Parameters
- keyPath: string
- thenShortcut: ThenShortcut<T[], R>
Returns Promise<R>

toArray

toArray(): Promise<Array<T>>
toArray<R>(thenShortcut: ThenShortcut<T[], R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:410
Returns Promise<Array<T>>
- Defined in node_modules/dexie/dist/dexie.d.ts:411
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<T[], R>
Returns Promise<R>

uniqueKeys

uniqueKeys(): Promise<IndexableTypeArray>
uniqueKeys<R>(thenShortcut: ThenShortcut<IndexableTypeArray, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:412
Returns Promise<IndexableTypeArray>
- Defined in node_modules/dexie/dist/dexie.d.ts:413
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<IndexableTypeArray, R>
Returns Promise<R>

until

until(filter: (value: T) => boolean, includeStopEntry?: undefined | false | true): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:414
Parameters
- filter: (value: T) => boolean
 - - (value: T): boolean
 - Parameters
 - value: T
 Returns boolean
- Optional includeStopEntry: undefined | false | true
Returns Collection<T, Key>

Table

Table<T, Key>: {}

Type parameters

Type declaration

hook

hook: TableHooks<T, Key>

name

name: string

schema

schema: TableSchema

add

add(item: T, key?: Key): Promise<Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:351
Parameters
- item: T
- Optional key: Key
Returns Promise<Key>

bulkAdd

bulkAdd(items: T[], keys?: IndexableTypeArrayReadonly): Promise<Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:356
Parameters
- items: T[]
- Optional keys: IndexableTypeArrayReadonly
Returns Promise<Key>

bulkDelete

bulkDelete(keys: IndexableTypeArrayReadonly): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:358
Parameters
- keys: IndexableTypeArrayReadonly
Returns Promise<void>

bulkPut

bulkPut(items: T[], keys?: IndexableTypeArrayReadonly): Promise<Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:357
Parameters
- items: T[]
- Optional keys: IndexableTypeArrayReadonly
Returns Promise<Key>

clear

clear(): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:355
Returns Promise<void>

count

count(): Promise<number>
count<R>(thenShortcut: ThenShortcut<number, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:335
Returns Promise<number>
- Defined in node_modules/dexie/dist/dexie.d.ts:336
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<number, R>
Returns Promise<R>

delete

delete(key: Key): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:354
Parameters
- key: Key
Returns Promise<void>

each

each(callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any): Promise<void>

- Defined in node_modules/dexie/dist/dexie.d.ts:342
Parameters
- callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any
 - - (obj: T, cursor: { key: IndexableType; primaryKey: Key }): any
 - Parameters
 - obj: T
 - cursor: { key: IndexableType; primaryKey: Key }
 
 key: IndexableType
 
 primaryKey: Key
 Returns any
Returns Promise<void>

filter

filter(fn: (obj: T) => boolean): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:333
Parameters
- fn: (obj: T) => boolean
 - - (obj: T): boolean
 - Parameters
 - obj: T
 Returns boolean
Returns Collection<T, Key>

get

get(key: Key): Promise<T | undefined>
get<R>(key: Key, thenShortcut: ThenShortcut<T | undefined, R>): Promise<R>
get(equalityCriterias: {}): Promise<T | undefined>
get<R>(equalityCriterias: {}, thenShortcut: ThenShortcut<T | undefined, R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:326
Parameters
- key: Key
Returns Promise<T | undefined>
- Defined in node_modules/dexie/dist/dexie.d.ts:327
Type parameters
- R
Parameters
- key: Key
- thenShortcut: ThenShortcut<T | undefined, R>
Returns Promise<R>
- Defined in node_modules/dexie/dist/dexie.d.ts:328
Parameters
- equalityCriterias: {}
 - [key: string]: IndexableType
Returns Promise<T | undefined>
- Defined in node_modules/dexie/dist/dexie.d.ts:329
Type parameters
- R
Parameters
- equalityCriterias: {}
 - [key: string]: IndexableType
- thenShortcut: ThenShortcut<T | undefined, R>
Returns Promise<R>

limit

limit(n: number): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:340
Parameters
- n: number
Returns Collection<T, Key>

mapToClass

mapToClass(constructor: Function): Function

- Defined in node_modules/dexie/dist/dexie.d.ts:350
Parameters
- constructor: Function
Returns Function

offset

offset(n: number): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:338
Parameters
- n: number
Returns Collection<T, Key>

orderBy

orderBy(index: string | string[]): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:348
Parameters
- index: string | string[]
Returns Collection<T, Key>

put

put(item: T, key?: Key): Promise<Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:353
Parameters
- item: T
- Optional key: Key
Returns Promise<Key>

reverse

reverse(): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:349
Returns Collection<T, Key>

toArray

toArray(): Promise<Array<T>>
toArray<R>(thenShortcut: ThenShortcut<T[], R>): Promise<R>

- Defined in node_modules/dexie/dist/dexie.d.ts:344
Returns Promise<Array<T>>
- Defined in node_modules/dexie/dist/dexie.d.ts:345
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<T[], R>
Returns Promise<R>

toCollection

toCollection(): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:347
Returns Collection<T, Key>

update

update(key: Key, changes: {}): Promise<number>

- Defined in node_modules/dexie/dist/dexie.d.ts:352
Parameters
- key: Key
- changes: {}
 - [keyPath: string]: any
Returns Promise<number>

where

where(index: string | string[]): WhereClause<T, Key>
where(equalityCriterias: {}): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:330
Parameters
- index: string | string[]
Returns WhereClause<T, Key>
- Defined in node_modules/dexie/dist/dexie.d.ts:331
Parameters
- equalityCriterias: {}
 - [key: string]: IndexableType
Returns Collection<T, Key>

Transaction

Transaction: {}

Type declaration

active

active: boolean

db

db: Dexie

idbtrans

idbtrans: IDBTransaction

mode

mode: string

on

on: TransactionEvents

storeNames

storeNames: Array<string>

tables

tables: {}

Type declaration

[type: string]: Table<any, any>

abort

abort(): void

- Defined in node_modules/dexie/dist/dexie.d.ts:232
Returns void

table

table(tableName: string): Table<any, any>
table<T>(tableName: string): Table<T, any>
table<T, Key>(tableName: string): Table<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:233
Parameters
- tableName: string
Returns Table<any, any>
- Defined in node_modules/dexie/dist/dexie.d.ts:234
Type parameters
- T
Parameters
- tableName: string
Returns Table<T, any>
- Defined in node_modules/dexie/dist/dexie.d.ts:235
Type parameters
- T
- Key
Parameters
- tableName: string
Returns Table<T, Key>

Version

Version: {}

Type declaration

stores

stores(schema: {}): Version

- Defined in node_modules/dexie/dist/dexie.d.ts:220
Parameters
- schema: {}
  - [key: string]: string | null
Returns Version

upgrade

upgrade(fn: (trans: Transaction) => void): Version

- Defined in node_modules/dexie/dist/dexie.d.ts:221
Parameters
- fn: (trans: Transaction) => void
  - - (trans: Transaction): void
    - Parameters
      - trans: Transaction
      Returns void
Returns Version

WhereClause

WhereClause<T, Key>: {}

Type parameters

Type declaration

above

above(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:362
Parameters
- key: IndexableType
Returns Collection<T, Key>

aboveOrEqual

aboveOrEqual(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:363
Parameters
- key: IndexableType
Returns Collection<T, Key>

anyOf

anyOf(keys: IndexableTypeArrayReadonly): Collection<T, Key>
anyOf(...keys: IndexableTypeArray): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:364
Parameters
- keys: IndexableTypeArrayReadonly
Returns Collection<T, Key>
- Defined in node_modules/dexie/dist/dexie.d.ts:365
Parameters
- Rest ...keys: IndexableTypeArray
Returns Collection<T, Key>

anyOfIgnoreCase

anyOfIgnoreCase(keys: string[]): Collection<T, Key>
anyOfIgnoreCase(...keys: string[]): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:366
Parameters
- keys: string[]
Returns Collection<T, Key>
- Defined in node_modules/dexie/dist/dexie.d.ts:367
Parameters
- Rest ...keys: string[]
Returns Collection<T, Key>

below

below(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:368
Parameters
- key: IndexableType
Returns Collection<T, Key>

belowOrEqual

belowOrEqual(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:369
Parameters
- key: IndexableType
Returns Collection<T, Key>

between

between(lower: IndexableType, upper: IndexableType, includeLower?: undefined | false | true, includeUpper?: undefined | false | true): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:370
Parameters
- lower: IndexableType
- upper: IndexableType
- Optional includeLower: undefined | false | true
- Optional includeUpper: undefined | false | true
Returns Collection<T, Key>

equals

equals(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:371
Parameters
- key: IndexableType
Returns Collection<T, Key>

equalsIgnoreCase

equalsIgnoreCase(key: string): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:372
Parameters
- key: string
Returns Collection<T, Key>

inAnyRange

inAnyRange(ranges: Array<IndexableTypeArrayReadonly>): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:373
Parameters
- ranges: Array<IndexableTypeArrayReadonly>
Returns Collection<T, Key>

noneOf

noneOf(keys: Array<IndexableType>): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:380
Parameters
- keys: Array<IndexableType>
Returns Collection<T, Key>

notEqual

notEqual(key: IndexableType): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:381
Parameters
- key: IndexableType
Returns Collection<T, Key>

startsWith

startsWith(key: string): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:374
Parameters
- key: string
Returns Collection<T, Key>

startsWithAnyOf

startsWithAnyOf(prefixes: string[]): Collection<T, Key>
startsWithAnyOf(...prefixes: string[]): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:375
Parameters
- prefixes: string[]
Returns Collection<T, Key>
- Defined in node_modules/dexie/dist/dexie.d.ts:376
Parameters
- Rest ...prefixes: string[]
Returns Collection<T, Key>

startsWithAnyOfIgnoreCase

startsWithAnyOfIgnoreCase(prefixes: string[]): Collection<T, Key>
startsWithAnyOfIgnoreCase(...prefixes: string[]): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:378
Parameters
- prefixes: string[]
Returns Collection<T, Key>
- Defined in node_modules/dexie/dist/dexie.d.ts:379
Parameters
- Rest ...prefixes: string[]
Returns Collection<T, Key>

startsWithIgnoreCase

startsWithIgnoreCase(key: string): Collection<T, Key>

- Defined in node_modules/dexie/dist/dexie.d.ts:377
Parameters
- key: string
Returns Collection<T, Key>

courses

courses: Table<CourseTableItem, string>

Readonly name

name: string

on

on: DbEvents

sections

sections: Table<SectionTableItem, number>

Readonly tables

tables: Table<any, any>[]

Readonly verno

verno: number

Static Events

Events: any

Static IndexSpec

IndexSpec: {}

Type declaration

Static Promise

Promise: DexiePromiseConstructor

Static TableSchema

TableSchema: {}

Type declaration

Static addons

addons: Array<(db: Dexie) => void>

Static currentTransaction

currentTransaction: Transaction

Static default

default: Dexie

Static dependencies

dependencies: { IDBKeyRange: IDBKeyRange; indexedDB: IDBFactory }

Type declaration

IDBKeyRange: IDBKeyRange
indexedDB: IDBFactory

Static errnames

errnames: { Abort: "AbortError"; Constraint: "ConstraintError"; Data: "DataError"; DataClone: "DataCloneError"; DatabaseClosed: "DatabaseClosedError"; Internal: "InternalError"; InvalidAccess: "InvalidAccessError"; InvalidArgument: "InvalidArgumentError"; InvalidState: "InvalidStateError"; InvalidTable: "InvalidTableError"; MissingAPI: "MissingAPIError"; Modify: "ModifyError"; NoSuchDatabase: "NoSuchDatabaseError"; NotFound: "NotFoundError"; OpenFailed: "OpenFailedError"; QuotaExceeded: "QuotaExceededError"; ReadOnly: "ReadOnlyError"; Schema: "SchemaError"; SubTransaction: "Error"; Syntax: "SyntaxError"; Timeout: "TimeoutError"; TransactionInactive: "TransactionInactiveError"; Unknown: "UnknownError"; Unsupported: "UnsupportedError"; Upgrade: "UpgradeError"; Version: "VersionError"; VersionChange: "VersionChangeError" }

Type declaration

Abort: "AbortError"
Constraint: "ConstraintError"
Data: "DataError"
DataClone: "DataCloneError"
DatabaseClosed: "DatabaseClosedError"
Internal: "InternalError"
InvalidAccess: "InvalidAccessError"
InvalidArgument: "InvalidArgumentError"
InvalidState: "InvalidStateError"
InvalidTable: "InvalidTableError"
MissingAPI: "MissingAPIError"
Modify: "ModifyError"
NoSuchDatabase: "NoSuchDatabaseError"
NotFound: "NotFoundError"
OpenFailed: "OpenFailedError"
QuotaExceeded: "QuotaExceededError"
ReadOnly: "ReadOnlyError"
Schema: "SchemaError"
SubTransaction: "Error"
Syntax: "SyntaxError"
Timeout: "TimeoutError"
TransactionInactive: "TransactionInactiveError"
Unknown: "UnknownError"
Unsupported: "UnsupportedError"
Upgrade: "UpgradeError"
Version: "VersionError"
VersionChange: "VersionChangeError"

Static maxKey

maxKey: Array<Array<void>> | string

Static minKey

minKey: number

Static semVer

semVer: string

Static version

version: number

Methods

backendDB

backendDB(): IDBDatabase

Inherited from CatalogDB.backendDB
- Defined in node_modules/dexie/dist/dexie.d.ts:111
Returns IDBDatabase

close

close(): void

Inherited from CatalogDB.close
- Defined in node_modules/dexie/dist/dexie.d.ts:99
Returns void

delete

delete(): Promise<void>

Inherited from CatalogDB.delete
- Defined in node_modules/dexie/dist/dexie.d.ts:101
Returns Promise<void>

dynamicallyOpened

dynamicallyOpened(): boolean

Inherited from CatalogDB.dynamicallyOpened
- Defined in node_modules/dexie/dist/dexie.d.ts:109
Returns boolean

empty

empty(): Promise<boolean>

- Defined in src/data/CatalogDB.ts:38
Returns Promise<boolean>

hasBeenClosed

hasBeenClosed(): boolean

Inherited from CatalogDB.hasBeenClosed
- Defined in node_modules/dexie/dist/dexie.d.ts:105
Returns boolean

hasFailed

hasFailed(): boolean

Inherited from CatalogDB.hasFailed
- Defined in node_modules/dexie/dist/dexie.d.ts:107
Returns boolean

isOpen

isOpen(): boolean

Inherited from CatalogDB.isOpen
- Defined in node_modules/dexie/dist/dexie.d.ts:103
Returns boolean

open

open(): Promise<Dexie>

Inherited from CatalogDB.open
- Defined in node_modules/dexie/dist/dexie.d.ts:79
Returns Promise<Dexie>

saveTimeStamp

saveTimeStamp(): Promise<void>

- Defined in src/data/CatalogDB.ts:47
Returns Promise<void>

table

table(tableName: string): Table<any, any>
table<T>(tableName: string): Table<T, any>
table<T, Key>(tableName: string): Table<T, Key>

Inherited from CatalogDB.table
- Defined in node_modules/dexie/dist/dexie.d.ts:81
Parameters
- tableName: string
Returns Table<any, any>
Inherited from CatalogDB.table
- Defined in node_modules/dexie/dist/dexie.d.ts:83
Type parameters
- T
Parameters
- tableName: string
Returns Table<T, any>
Inherited from CatalogDB.table
- Defined in node_modules/dexie/dist/dexie.d.ts:85
Type parameters
- T
- Key
Parameters
- tableName: string
Returns Table<T, Key>

timestamp

timestamp(): Promise<number>

- Defined in src/data/CatalogDB.ts:43
Returns Promise<number>

transaction

transaction(mode: TransactionMode, table: Table<any, any>, scope: () => PromiseLike | U): Promise
transaction(mode: TransactionMode, table: Table<any, any>, table2: Table<any, any>, scope: () => PromiseLike | U): Promise
transaction(mode: TransactionMode, table: Table<any, any>, table2: Table<any, any>, table3: Table<any, any>, scope: () => PromiseLike | U): Promise
transaction(mode: TransactionMode, table: Table<any, any>, table2: Table<any, any>, table3: Table<any, any>, table4: Table<any, any>, scope: () => PromiseLike | U): Promise
transaction(mode: TransactionMode, table: Table<any, any>, table2: Table<any, any>, table3: Table<any, any>, table4: Table<any, any>, table5: Table<any, any>, scope: () => PromiseLike | U): Promise
transaction(mode: TransactionMode, tables: Table<any, any>[], scope: () => PromiseLike | U): Promise

Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:87
Type parameters
- U
Parameters
- mode: TransactionMode
- table: Table<any, any>
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise
Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:89
Type parameters
- U
Parameters
- mode: TransactionMode
- table: Table<any, any>
- table2: Table<any, any>
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise
Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:91
Type parameters
- U
Parameters
- mode: TransactionMode
- table: Table<any, any>
- table2: Table<any, any>
- table3: Table<any, any>
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise
Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:93
Type parameters
- U
Parameters
- mode: TransactionMode
- table: Table<any, any>
- table2: Table<any, any>
- table3: Table<any, any>
- table4: Table<any, any>
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise
Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:95
Type parameters
- U
Parameters
- mode: TransactionMode
- table: Table<any, any>
- table2: Table<any, any>
- table3: Table<any, any>
- table4: Table<any, any>
- table5: Table<any, any>
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise
Inherited from CatalogDB.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:97
Type parameters
- U
Parameters
- mode: TransactionMode
- tables: Table<any, any>[]
- scope: () => PromiseLike | U
 - - (): PromiseLike | U
 - Returns PromiseLike | U
Returns Promise

version

version(versionNumber: Number): Version

Inherited from CatalogDB.version
- Defined in node_modules/dexie/dist/dexie.d.ts:75
Parameters
- versionNumber: Number
Returns Version

vip

vip(scopeFunction: () => U): U

Inherited from CatalogDB.vip
- Defined in node_modules/dexie/dist/dexie.d.ts:113
Type parameters
- U
Parameters
- scopeFunction: () => U
  - - (): U
    - Returns U
Returns U

Static asap

asap(fn: Function): void

Inherited from CatalogDB.asap
- Defined in node_modules/dexie/dist/dexie.d.ts:59
Parameters
- fn: Function
Returns void

Static deepClone

deepClone<T>(obj: T): T

Inherited from CatalogDB.deepClone
- Defined in node_modules/dexie/dist/dexie.d.ts:57
Type parameters
- T
Parameters
- obj: T
Returns T

Static delByKeyPath

delByKeyPath(obj: Object, keyPath: string): void

Inherited from CatalogDB.delByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:53
Parameters
- obj: Object
- keyPath: string
Returns void

Static delete

delete(dbName: string): Promise<void>

Inherited from CatalogDB.delete
- Defined in node_modules/dexie/dist/dexie.d.ts:66
Parameters
- dbName: string
Returns Promise<void>

Static exists

exists(dbName: string): Promise<boolean>

Inherited from CatalogDB.exists
- Defined in node_modules/dexie/dist/dexie.d.ts:64
Parameters
- dbName: string
Returns Promise<boolean>

Static getByKeyPath

getByKeyPath(obj: Object, keyPath: string): any

Inherited from CatalogDB.getByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:49
Parameters
- obj: Object
- keyPath: string
Returns any

Static getDatabaseNames

getDatabaseNames(): Promise<string[]>
getDatabaseNames<R>(thenShortcut: ThenShortcut<string[], R>): Promise<R>

Inherited from CatalogDB.getDatabaseNames
- Defined in node_modules/dexie/dist/dexie.d.ts:44
Returns Promise<string[]>
Inherited from CatalogDB.getDatabaseNames
- Defined in node_modules/dexie/dist/dexie.d.ts:45
Type parameters
- R
Parameters
- thenShortcut: ThenShortcut<string[], R>
Returns Promise<R>

Static override

override<F>(origFunc: F, overridedFactory: (fn: any) => any): F

Inherited from CatalogDB.override
- Defined in node_modules/dexie/dist/dexie.d.ts:47
Type parameters
- F
Parameters
- origFunc: F
- overridedFactory: (fn: any) => any
  - - (fn: any): any
    - Parameters
      - fn: any
      Returns any
Returns F

Static setByKeyPath

setByKeyPath(obj: Object, keyPath: string, value: any): void

Inherited from CatalogDB.setByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:51
Parameters
- obj: Object
- keyPath: string
- value: any
Returns void

Static shallowClone

shallowClone<T>(obj: T): T

Inherited from CatalogDB.shallowClone
- Defined in node_modules/dexie/dist/dexie.d.ts:55
Type parameters
- T
Parameters
- obj: T
Returns T

Static waitFor

waitFor<T>(promise: PromiseLike<T> | T): Promise<T>
waitFor<T>(promise: PromiseLike<T> | T, timeoutMilliseconds: number): Promise<T>

Inherited from CatalogDB.waitFor
- Defined in node_modules/dexie/dist/dexie.d.ts:41
Type parameters
- T
Parameters
- promise: PromiseLike<T> | T
Returns Promise<T>
Inherited from CatalogDB.waitFor
- Defined in node_modules/dexie/dist/dexie.d.ts:42
Type parameters
- T
Parameters
- promise: PromiseLike<T> | T
- timeoutMilliseconds: number
Returns Promise<T>

Hierarchy

Index

Classes

Interfaces

Constructors

Properties

Methods

Constructors

constructor

Parameters

semester: SemesterJSON

Returns CatalogDB

Properties

Collection

Type parameters

T

Key

Type declaration

and

Parameters

filter: (x: T) => boolean

Parameters

x: T

Returns boolean

Returns Collection<T, Key>

clone

Parameters

Optional props: Object

Returns Collection<T, Key>

count

Returns Promise<number>

Type parameters

R

Parameters

thenShortcut: ThenShortcut<number, R>

Returns Promise<R>

delete

Returns Promise<number>

distinct

Returns Collection<T, Key>

each

Parameters

callback: (obj: T, cursor: { key: IndexableType; primaryKey: Key }) => any

Parameters

obj: T

cursor: { key: IndexableType; primaryKey: Key }

key: IndexableType

primaryKey: Key

Returns any

Returns Promise<void>

eachKey

Parameters

callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any

Parameters

key: IndexableType

cursor: { key: IndexableType; primaryKey: Key }

key: IndexableType

primaryKey: Key

Returns any

Returns Promise<void>

eachPrimaryKey

Parameters

callback: (key: Key, cursor: { key: IndexableType; primaryKey: Key }) => any

Parameters

key: Key

cursor: { key: IndexableType; primaryKey: Key }

key: IndexableType

primaryKey: Key

Returns any

Returns Promise<void>

eachUniqueKey

Parameters

callback: (key: IndexableType, cursor: { key: IndexableType; primaryKey: Key }) => any

Parameters

key: IndexableType

cursor: { key: IndexableType; primaryKey: Key }

key: IndexableType

primaryKey: Key

Returns any

Returns Promise<void>