G
G
Golem SDK
Search…
yapapi - Python high-level API
yajsapi - JavaScript high-level API
Yagna Contributor Guide
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

Table of contents

Constructors

Methods

Constructors

constructor

new Model()
Defined in

Methods

_custom_mapping

_custom_mapping(props, data): void
Parameters
Name
Type
props
object
data
object
Returns
void
Defined in

fields

fields(cls): Field[]
Parameters
Name
Type
cls
any
Returns
Field[]
Defined in

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

keys

keys(): any
example
1
import { props } from "yajsapi"
2
const { Field, Model } = props;
3
export class NodeInfo extends Model {
4
name: Field = new Field({ metadata: { key: "golem.node.id.name" } });
5
subnet_tag: Field = new Field({
6
metadata: { key: "golem.node.debug.subnet" },
7
});
8
}
9
new NodeInfo().keys().name()
10
// Output: 'golem.node.id.name'
Copied!
Returns
any
a mapping between the model's field names and the property keys
Defined in
Last modified 3mo ago