@konsumation/model

@konsumation/model

Data model of the konsumation apps

API

Table of Contents

• AttributeDefinition
  • Properties
• description
• name
• id
• unit
• unit
• schemaVersion
• serial
• validFrom
• fractionalDigits
• fractionalDigits
• Base
  • attributeNames
  • getAttributes
  • setAttributes
    • Parameters
  • type
  • attributes
  • attributeNameMapping
  • attributeNames
• Category
  • Parameters
  • name
  • description
  • fractionalDigits
  • unit
  • write
    • Parameters
  • delete
    • Parameters
  • meters
    • Parameters
  • activeMeter
    • Parameters
  • addMeter
    • Parameters
  • notes
    • Parameters
  • values
    • Parameters
  • writeValue
    • Parameters
  • deleteValue
    • Parameters
  • text
    • Parameters
  • type
• SCHEMA_VERSION_2
• SCHEMA_VERSION_3
• SCHEMA_VERSION_CURRENT
• Master
  • Parameters
  • Properties
  • write
    • Parameters
  • close
  • addCategory
    • Parameters
  • categories
  • category
    • Parameters
  • text
  • initialize
    • Parameters
• Meter
  • Parameters
  • name
  • category
  • description
  • serial
  • validFrom
  • write
    • Parameters
  • delete
    • Parameters
  • values
    • Parameters
  • writeValue
    • Parameters
  • deleteValue
    • Parameters
  • notes
    • Parameters
  • addNote
    • Parameters
  • text
    • Parameters
  • type
• Note
  • Parameters
  • name
  • description
  • meter
  • write
    • Parameters
  • delete
    • Parameters
  • text
    • Parameters
  • type
• toText
  • Parameters

AttributeDefinition

Type: Object

Properties

• type string
• isKey boolean
• writable boolean
• mandatory boolean
• default any? the default value

description

Type: AttributeDefinition

name

Type: AttributeDefinition

id

Type: AttributeDefinition

unit

Type: AttributeDefinition

Returns string

unit

Type: string?

schemaVersion

Type: AttributeDefinition

serial

Type: AttributeDefinition

validFrom

Type: AttributeDefinition

fractionalDigits

Type: AttributeDefinition

fractionalDigits

Type: number?

Base

attributeNames

Attribute names on the javascript side.

Returns Array<string>

getAttributes

Object keys are the mapped external attribute names.

Returns Object

setAttributes

Sets values with external attribute names.

Parameters

• values Object

type

Returns string

attributes

Attribute definitions.

Returns Object

attributeNameMapping

Maping of attribute names from internal (javascript) to external (database).

Returns Object

attributeNames

Attribute names on the javascript side.

Returns Array<string>

Category

Extends Base

Value Category.

Parameters

• values Object

name

Type: string

description

Type: string?

fractionalDigits

Type: number?

unit

Type: string?

write

Write into store.

Parameters

• context any

delete

Delete Category from store.

Parameters

• context any

meters

List assigned meters.

Parameters

• context any

• options Object?

  • options.gte string? from name
  • options.lte string? up to name
  • options.reverse boolean? order

Returns AsyncIterable<Meter>

activeMeter

Currently active Meter.

Parameters

• context any

Returns Promise<(Meter | undefined)>

addMeter

Add a meter to the category;

Parameters

• values Object (optional, default {})

Returns Promise<Meter>

notes

All notes from all meters.

Parameters

• context any

Returns AsyncIterable<Note>

values

All values from all meters.

Parameters

• context any

Returns AsyncIterable<{date: Date, value: number}>

writeValue

Add a value to the active meter.

Parameters

• context any
• time Date
• value number

Returns Promise<any>

deleteValue

Delete a value from the active meter.

Parameters

• context any
• time Date

Returns Promise<any>

text

Text representation.

Parameters

• context any

Returns AsyncIterable<string>

type

Name of the type in text dump

Returns string

SCHEMA_VERSION_2

Schema with type + name

Type: string

SCHEMA_VERSION_3

Values are attached to the meter

Type: string

SCHEMA_VERSION_CURRENT

Schema version for newly created databases

Master

Extends Base

Parameters

• values

Properties

• schemaVersion string

write

Write attributes store.

Parameters

• context any

close

addCategory

Add a category.

Parameters

• values Object

Returns Promise<Category>

categories

Returns AsyncIterable<Category>

category

Parameters

• name string

Returns Promise<(Category | undefined)>

text

Create text representation

Returns AsyncIterable<string>

initialize

Parameters

• values (Object | string)

Returns Promise<Master>

Meter

Extends Base

Parameters

• values Object

name

Type: string

category

Type: Category

description

Type: string?

serial

Type: string?

validFrom

Type: Date?

write

Parameters

• context any

delete

Parameters

• context any

values

Parameters

• context any

Returns AsyncIterable<{date: Date, value: number}>

writeValue

Write new value.

Parameters

• context any
• time Date
• value number

deleteValue

Delete a value.

Parameters

• context any
• time Date

notes

List assigned Notes.

Parameters

• context any
• options Object?

Returns AsyncIterable<Note>

addNote

Add a note to the meter;

Parameters

• values Object (optional, default {})

Returns Promise<Note>

text

Text representation.

Parameters

• context any

Returns AsyncIterable<string>

type

Name of the type in text dump

Returns string

Note

Extends Base

Parameters

• values Object

name

Type: string

description

Type: string?

meter

Type: Meter

write

Write into store.

Parameters

• context any

delete

Delete from store.

Parameters

• context any

text

Text representation.

Parameters

• context any

Returns AsyncIterable<string>

type

Name of the type in text dump

Returns string

toText

Text representation.

Parameters

• context any
• object Base
• key string
• iterators ...any

Returns AsyncIterable<string>

install

With npm do:

npm install @konsumation/model

license

BSD-2-Clause