Class: Model

​yajsapi / Exports / props/base / Model
Class: Model
​props/base.Model
Base class from which all property models inherit.
description Provides helper methods to load the property model data from an object and to get a mapping of all the keys available in the given model.
Hierarchy
Model
↳ Com​
↳ NodeInfo​
↳ Activity​
↳ ExeUnitRequest​
Table of contents
Constructors
​constructor​
Methods
​_custom_mapping​
​fields​
​from_properties​
​keys​
Constructors
constructor
• new Model()
Defined in
​yajsapi/props/base.ts:108​
Methods
_custom_mapping
▸ _custom_mapping(props, data): void
Parameters
Name
Type
props
object
data
object
Returns
void
Defined in
​yajsapi/props/base.ts:111​
fields
▸ fields(cls): Field[]
Parameters
Name
Type
cls
any
Returns
​Field[]
Defined in
​yajsapi/props/base.ts:113​
from_properties
▸ from_properties(props): any
Initialize the model from an object representation.
description When provided with an object of properties, it will find the matching keys within it and fill the model fields with the values from the object.
It ignores non-matching keys - i.e. doesn't require filtering of the properties' object before the model is fed with the data. Thus, several models can be initialized from the same object and all models will only load their own data.
Parameters
Name
Type
props
object
Returns
any
Defined in
​yajsapi/props/base.ts:137​
keys
▸ keys(): any
example
import { props } from "yajsapi"
const { Field, Model } = props;
export class NodeInfo extends Model {
  name: Field = new Field({ metadata: { key: "golem.node.id.name" } });
  subnet_tag: Field = new Field({
    metadata: { key: "golem.node.debug.subnet" },
  });
}
new NodeInfo().keys().name()
// Output: 'golem.node.id.name'
Returns
any
a mapping between the model's field names and the property keys
Defined in
​yajsapi/props/base.ts:182​

Name	Type
`props`	`object`
`data`	`object`

Name	Type
`cls`	`any`

Name	Type
`props`	`object`

Class: Field

Class: DemandBuilder

Last modified 1yr ago