​yajsapi / Exports / props / NodeInfo

Class: NodeInfo

​props.NodeInfo

Hierarchy

• ​Model​

  ↳ NodeInfo

Table of contents

Constructors

• ​constructor​

Properties

• ​name​

• ​subnet_tag​

Methods

• ​_custom_mapping​

• ​fields​

• ​from_properties​

• ​keys​

Constructors

constructor

• new NodeInfo(subnet_tag?, name?)

Parameters

Overrides

​Model.constructor​

Defined in

​yajsapi/props/index.ts:10​

Properties

name

• name: Field​

Defined in

​yajsapi/props/index.ts:7​

subnet_tag

• subnet_tag: Field​

Defined in

​yajsapi/props/index.ts:8​

Methods

_custom_mapping

▸ _custom_mapping(props, data): void

Parameters

Returns

void

Inherited from

​Model._custom_mapping​

Defined in

​yajsapi/props/base.ts:111​

fields

▸ fields(cls): Field[]

Parameters

Returns

​Field[]

Inherited from

​Model.fields​

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

Returns

any

Inherited from

​Model.from_properties​

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

Inherited from

​Model.keys​

Defined in

​yajsapi/props/base.ts:182​