Class GeneralMetadata

General metadata with a basic structure.

This metadata can be associated with a variety of objects within SolarNetwork, such as users, nodes, and datum.

Hierarchy

GeneralMetadata

Index

Constructors

Properties

info? propertyInfo? tags?

Methods

toJsonEncoding fromJsonEncoding

Constructors

constructor

new GeneralMetadata(info?, propertyInfo?, tags?): GeneralMetadata
Constructor.
Parameters
- Optional info: Map<string, any>
  
  the general metadata map
- Optional propertyInfo: Map<string, Map<string, any>>
  
  the property metadata map
- Optional tags: string[] | Set<string>
  
  the tags
Returns GeneralMetadata
- Defined in src/main/domain/generalMetadata.ts:26

Properties

`Optional` info

info?: Map<string, any>

The general metadata map.

`Optional` propertyInfo

propertyInfo?: Map<string, Map<string, any>>

The property metadata map.

`Optional` tags

tags?: Set<string>

The tags.

Methods

toJsonEncoding

toJsonEncoding(): string
Get this object as a standard JSON encoded string value.

Returns string
the JSON encoded string
- Defined in src/main/domain/generalMetadata.ts:46

`Static` fromJsonEncoding

fromJsonEncoding(json): GeneralMetadata
Parse a JSON string into a GeneralMetadata instance.

The JSON must be encoded the same way Domain.GeneralMetadata#toJsonEncoding does.
Parameters
- json: string
  
  the JSON to parse
Returns GeneralMetadata
the metadata instance
- Defined in src/main/domain/generalMetadata.ts:72

Generated using TypeDoc