@konsumation/db-level v9.0.15
konsum-db
timeseries database on leveldb
example
import levelup from "levelup";
import leveldown from "leveldown";
import { Master, Category } from "konsum-db";
async function example() {
// open database
const db = await levelup(leveldown("example.db"));
const master = await Master.initialize(db);
// create category named EV
const ev = new Category("EV", master, { unit: "kWh" });
await ev.write(master.db);
// write entry
await ev.writeValue(db, Date.now(), 77.34);
}
example();
API
Table of Contents
- LevelCategory
- MASTER
- CATEGORY_PREFIX
- VALUE_PREFIX
- METER_PREFIX
- NOTE_PREFIX
- LevelMaster
- LevelMeter
- LevelNote
- secondsAsString
- LevelValue
LevelCategory
Extends Category
Value Category.
Parameters
Properties
name
string category namedescription
stringunit
string physical unitfractionalDigits
number display precission
write
- See: {key}
Writes object into database. Leaves all other entries alone.
Parameters
db
ClassicLevel
key
Returns string
meters
Get Meters of the category.
Parameters
db
ClassicLeveloptions
Object?
Returns AsyncIterable\
entries
Get categories.
Parameters
db
ClassicLevelgte
(string | undefined) lowest name (optional, default"\u0000"
)lte
(string | undefined) highst name (optional, default"\uFFFF"
)
Returns AsyncIterable\
MASTER
Prefix of the master record
Type: string
CATEGORY_PREFIX
Prefix of the categories. Will be followed by the category name
Type: string
VALUE_PREFIX
Prefix of the values. Will be followed by the category name
Type: string
METER_PREFIX
Prefix of the meters. Will be followed by the category name
Type: string
NOTE_PREFIX
Prefix of the notes. Will be followed by the category name
Type: string
LevelMaster
Extends Master
Master record. Holds schema version.
Properties
schemaVersion
string
write
- See: {key}
Writes object into database. Leaves all other entries alone.
Parameters
db
ClassicLevel
close
Close the underlaying database.
categories
List Categories.
Parameters
initialize
Initialize database. checks/writes master record.
Parameters
directory
string
Returns Promise\
LevelMeter
Extends Meter
Meter
Parameters
Properties
name
string category namedescription
stringunit
string physical unitfractionalDigits
number display precission
notes
List assigned Notes.
Parameters
db
anyoptions
Object?
Returns AsyncIterable<LevelNote>
values
Get values of the meter.
Parameters
db
anyoptions
Object?
Returns AsyncIterable<{value: number, date: Date}>
key
Returns string
LevelNote
Extends Note
Hints placed on a category at a specific time.
key
Returns string
secondsAsString
Format seconds as string left padded with '0'.
Parameters
seconds
number seconds since epoch
Returns string padded seconds
LevelValue
Extends Value
Hints placed on a category at a specific time.
key
Returns string
9 days ago
9 days ago
9 days ago
9 days ago
9 days ago
10 days ago
11 days ago
13 days ago
14 days ago
15 days ago
15 days ago
15 days ago
15 days ago
16 days ago
16 days ago
16 days ago
17 days ago
18 days ago
18 days ago
21 days ago
21 days ago
21 days ago
22 days ago
24 days ago
24 days ago
25 days ago
25 days ago
25 days ago
24 days ago
24 days ago
26 days ago
27 days ago
28 days ago
28 days ago
28 days ago
29 days ago
29 days ago
1 month ago
1 month ago
1 month ago
30 days ago
30 days ago
30 days ago
30 days ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
1 month ago
2 months ago