@konsumation/model v3.7.2

@konsumation/model

Data model of the konsumation apps

API

Table of Contents

• AttributeDefinition
  • Properties
• description
• name
• id
• unit
• unit
• schemaVersion
• serial
• validFrom
• fractionalDigits
• fractionalDigits
• order
• value
• date
• isAggregating
• Base
  • isDefinedAttribute
    • Parameters
  • _getAttributes
    • Parameters
  • getLocalAttributes
    • Parameters
  • setAttributes
    • Parameters
  • type
  • attributes
  • attributeNameMapping
• Category
  • Parameters
  • name
  • description
  • fractionalDigits
  • unit
  • order
  • write
    • Parameters
  • delete
    • Parameters
  • meters
    • Parameters
  • meter
    • Parameters
  • activeMeter
    • Parameters
  • addMeter
    • Parameters
  • deleteMeter
    • Parameters
  • notes
    • Parameters
  • note
    • Parameters
  • values
    • Parameters
  • value
    • Parameters
  • latestValue
    • Parameters
  • addValue
    • Parameters
  • deleteValue
    • Parameters
  • text
    • Parameters
  • type
• SCHEMA_VERSION_2
• SCHEMA_VERSION_3
• SCHEMA_VERSION_CURRENT
• Master
  • Parameters
  • Properties
  • one
    • Parameters
  • all
    • Parameters
  • write
    • Parameters
  • close
  • addCategory
    • Parameters
  • categories
    • Parameters
  • category
    • Parameters
  • text
    • Parameters
  • fromText
    • Parameters
  • initialize
    • Parameters
• Meter
  • Parameters
  • name
  • category
  • description
  • serial
  • validFrom
  • isAggregating
  • write
    • Parameters
  • delete
    • Parameters
  • values
    • Parameters
  • value
    • Parameters
  • addValue
    • Parameters
  • deleteValue
    • Parameters
  • latestValue
    • Parameters
  • notes
    • Parameters
  • note
    • Parameters
  • addNote
    • Parameters
  • deleteNote
    • Parameters
  • text
    • Parameters
  • type
  • parentType
• Note
  • Parameters
  • name
  • description
  • meter
  • write
    • Parameters
  • delete
    • Parameters
  • text
    • Parameters
  • type
  • parentType
• toText
  • Parameters
• Value
  • Parameters
  • meter
  • date
  • value
  • write
    • Parameters
  • delete
    • Parameters
  • text
    • Parameters
  • type
  • parentType

AttributeDefinition

Type: Object

Properties

• type string
• regex RegExp?
• isKey boolean
• isForeign boolean do we represent a foreign entity
• 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?

order

Type: AttributeDefinition

value

Type: AttributeDefinition

date

Type: AttributeDefinition

isAggregating

Type: AttributeDefinition

Base

isDefinedAttribute

Is the given attribute defined in the target. Some attributes are inherited from parent object and therfore not defined in the target.

Parameters

• name string

Returns boolean

_getAttributes

Object keys are the mapped external attribute names.

Parameters

• mapping

Returns Object

getLocalAttributes

Object keys are the mapped external attribute names but only for local (not isForeign) ones.

Parameters

• mapping

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

Category

Extends Base

Value Category.

Parameters

• attributes Object

name

Type: string

description

Type: string?

fractionalDigits

Type: number?

unit

Type: string?

order

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>

meter

Deliver Meter for a given name.

Parameters

• context any
• name string

Returns Promise<(Meter | undefined)>

activeMeter

Currently active Meter.

Parameters

• context any
• create boolean Meter if none exist (optional, default false)

Returns Promise<(Meter | undefined)>

addMeter

Add a meter to the category;

Parameters

• context any

• attributes Object

  • attributes.name string
  • attributes.category Category?
  • attributes.validFrom Date?
  • attributes.description string?
  • attributes.serial string?
  • attributes.fractionalDigits number?
  • attributes.unit string?

Returns Meter

deleteMeter

Delete a meter.

Parameters

• context any
• name string

Returns Promise\

notes

All notes from all meters.

Parameters

• context any

Returns AsyncIterable<Note>

note

Deliver Value for a given date.

Parameters

• context any
• name string

Returns Promise<(Note | undefined)>

values

All values from all meters.

Parameters

• context any

Returns AsyncIterable<Value>

value

Deliver Value for a given date.

Parameters

• context any
• date Date

Returns Promise<(Value | undefined)>

latestValue

Get the latest value.

Parameters

• context any

Returns Promise<({date: Date, value: number} | undefined)>

addValue

Add a value to the active meter.

Parameters

• context any

• attributes Object

  • attributes.date Date
  • attributes.value number

Returns Promise\

deleteValue

Delete a value from the active meter.

Parameters

• context any
• date Date

Returns Promise\

text

Text representation.

Parameters

• context any

Returns AsyncIterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/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. Value dates may be given as iso date.

Type: string

SCHEMA_VERSION_CURRENT

Schema version for newly created databases

Master

Extends Base

Parameters

• values

Properties

• schemaVersion string

one

Query for one item.

Parameters

• query Object

  • query.category string?
  • query.meter string?
  • query.note string?
  • query.date (string | Date)?

Returns Promise<(Category | Meter | Note | Value | undefined)>

all

Query for several items.

Parameters

• query Object

  • query.category string?
  • query.meter string?
  • query.note string?
  • query.date (string | Date)?

Returns AsyncIterable<(Category | Meter | Note | Value)>

write

Write attributes store.

Parameters

• context any

close

Shut down backend store.

addCategory

Add a category.

Parameters

• context any

• attributes Object

  • attributes.name string
  • attributes.description string?
  • attributes.fractionalDigits number?
  • attributes.unit string?

Returns Category

categories

Parameters

• context any

Returns AsyncIterable<Category>

category

Parameters

• context any
• name string

Returns Promise<(Category | undefined)>

text

Create text representation

Parameters

• context (optional, default this.context)

Returns AsyncIterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

fromText

Parameters

• input AsyncIterable[Uint8Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array)

Returns Promise[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

initialize

Parameters

• values (Object | string)

Returns Promise<Master>

Meter

Extends Base

Parameters

• attributes Object

name

Type: string

category

Type: Category

description

Type: string?

serial

Type: string?

validFrom

Type: Date

isAggregating

Type: boolean

write

Parameters

• context any

delete

Parameters

• context any

values

Parameters

• context any

Returns AsyncIterable<Value>

value

Deliver value for a given date.

Parameters

• context any
• date Date

Returns Promise<(Value | undefined)>

addValue

Add a new value.

Parameters

• context any

• attributes Object

  • attributes.date Date
  • attributes.value number

Returns Promise<Value>

deleteValue

Delete a value.

Parameters

• context any
• date Date

Returns Promise\

latestValue

Get the latest value.

Parameters

• context any

Returns Promise<(Value | undefined)>

notes

List assigned Notes.

Parameters

• context any
• options Object?

Returns AsyncIterable<Note>

note

Deliver Note for a given name.

Parameters

• context any
• name string

Returns Promise<(Note | undefined)>

addNote

Add a note to the meter;

Parameters

• context any

• attributes Object

  • attributes.name string
  • attributes.meter Meter
  • attributes.description string?

Returns Note

deleteNote

delete a note.

Parameters

• context any
• name string

Returns Promise\

text

Text representation.

Parameters

• context any

Returns AsyncIterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

type

Name of the type in text dump.

Returns string

parentType

Name of the parents type.

Returns string

Note

Extends Base

Parameters

• attributes 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](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

type

Name of the type in text dump.

Returns string

parentType

Name of the parents type.

Returns string

toText

Text representation.

Parameters

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

Returns AsyncIterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

Value

Extends Base

Parameters

• attributes Object

meter

Type: Meter

date

Type: Date

value

Type: number

write

Write into store.

Parameters

• context any

delete

Delete from store.

Parameters

• context any

text

Text representation.

Parameters

• context any

Returns AsyncIterable[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)

type

Name of the type in text dump

Returns string

parentType

Name of the parents type.

Returns string

install

With npm do:

npm install @konsumation/model

license

BSD-2-Clause