@konsumation/model

Data model of the konsumation apps

API

$3

* 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

$3

* 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

$3

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

$3

Object keys are the mapped external attribute names.

#### Parameters

* mapping

Returns Object

$3

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

#### Parameters

* mapping

Returns Object

$3

Sets values with external attribute names.

#### Parameters

* values Object

$3

Returns string

$3

Attribute definitions.

Returns Object

$3

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

Returns Object

Category

Extends Base

Value Category.

$3

* attributes Object

$3

Type: string

$3

Type: string?

$3

Type: number?

$3

Type: string?

$3

Type: string?

$3

Write into store.

#### Parameters

* context any

$3

Delete Category from store.

#### Parameters

* context any

$3

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>

$3

Deliver Meter for a given name.

#### Parameters

* context any
* name string

Returns Promise<(Meter | undefined)>

$3

Currently active Meter.

#### Parameters

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

Returns Promise<(Meter | undefined)>

$3

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

$3

Delete a meter.

#### Parameters

* context any
* name string

Returns Promise\

$3

All notes from all meters.

#### Parameters

* context any

Returns AsyncIterable<Note>

$3

Deliver Value for a given date.

#### Parameters

* context any
* name string

Returns Promise<(Note | undefined)>

$3

All values from all meters.

#### Parameters

* context any

Returns AsyncIterable<Value>

$3

Deliver Value for a given date.

#### Parameters

* context any
* date Date

Returns Promise<(Value | undefined)>

$3

Get the latest value.

#### Parameters

* context any

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

$3

Add a value to the active meter.

#### Parameters

* context any
* attributes Object

* attributes.date Date
* attributes.value number

Returns Promise\

$3

Delete a value from the active meter.

#### Parameters

* context any
* date Date

Returns Promise\

$3

Text representation.

#### Parameters

* context any

Returns AsyncIterable<string>

$3

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

$3

* values

$3

* schemaVersion string

$3

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)>

$3

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)>

$3

Write attributes store.

#### Parameters

* context any

$3

Shut down backend store.

$3

Add a category.

#### Parameters

* context any
* attributes Object

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

Returns Category

$3

#### Parameters

* context any

Returns AsyncIterable<Category>

$3

#### Parameters

* context any
* name string

Returns Promise<(Category | undefined)>

$3

Create text representation

#### Parameters

* context (optional, default this.context)

Returns AsyncIterable<string>

$3

#### Parameters

* input AsyncIterable<Uint8Array>

Returns Promise<Object>

$3

#### Parameters

* values (Object | string)

Returns Promise<Master>

Meter

Extends Base

$3

* attributes Object

$3

Type: string

$3

Type: Category

$3

Type: string?

$3

Type: string?

$3

Type: Date

$3

Type: boolean

$3

#### Parameters

* context any

$3

#### Parameters

* context any

$3

#### Parameters

* context any

Returns AsyncIterable<Value>

$3

Deliver value for a given date.

#### Parameters

* context any
* date Date

Returns Promise<(Value | undefined)>

$3

Add a new value.

#### Parameters

* context any
* attributes Object

* attributes.date Date
* attributes.value number

Returns Promise<Value>

$3

Delete a value.

#### Parameters

* context any
* date Date

Returns Promise\

$3

Get the latest value.

#### Parameters

* context any

Returns Promise<(Value | undefined)>

$3

List assigned Notes.

#### Parameters

* context any
* options Object?

Returns AsyncIterable<Note>

$3

Deliver Note for a given name.

#### Parameters

* context any
* name string

Returns Promise<(Note | undefined)>

$3

Add a note to the meter;

#### Parameters

* context any
* attributes Object

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

Returns Note

$3

delete a note.

#### Parameters

* context any
* name string

Returns Promise\

$3

Text representation.

#### Parameters

* context any

Returns AsyncIterable<string>

$3

Name of the type in text dump.

Returns string

$3

Name of the parents type.

Returns string

Note

Extends Base

$3

* attributes Object

$3

Type: string

$3

Type: string?

$3

Type: Meter

$3

Write into store.

#### Parameters

* context any

$3

Delete from store.

#### Parameters

* context any

$3

Text representation.

#### Parameters

* context any

Returns AsyncIterable<string>

$3

Name of the type in text dump.

Returns string

$3

Name of the parents type.

Returns string

toText

Text representation.

$3

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

Returns AsyncIterable<string>

Value

Extends Base

$3

* attributes Object

$3

Type: Meter

$3

Type: Date

$3

Type: number

$3

Write into store.

#### Parameters

* context any

$3

Delete from store.

#### Parameters

* context any

$3

Text representation.

#### Parameters

* context any

Returns AsyncIterable<string>

$3

Name of the type in text dump

Returns string

$3

Name of the parents type.

Returns string

install

With npm do:

``shell
npm install @konsumation/model
``

license

BSD-2-Clause