NuKVM/xen-orchestra
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore(xen-api/_wrapRecord): basic documentation

Browse Source
This commit is contained in:
Julien Fontanet 2022-04-20 10:46:40 +02:00
parent 6da0aa376f
commit b1429e1df3
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
packages/xen-api/src/index.js
View File

@ -1259,6 +1259,15 @@ export class Xapi extends EventEmitter {
}
}
// Wrap a plain object record into an instance of a dedicated class (e.g. VM)
//
// This dedicated class contains the following helpers:
// - `$<name>` fields: return the cached object(s) pointed by the `<name>` field
// - `add_<name>(value)` async method: add a value to a set field
// - `remove_<name>(value)` async method: remove a value from a set field
// - `set_<name>(value)` async method: assigne a value to a field
// - `update_<name>(entry, value)` async method: set an entry of a map field to a value (remove if `null`)
// - `update_<name>(entries)` async method: update entries of a map field
_wrapRecord(type, ref, data) {
const RecordsByType = this._RecordsByType
let Record = RecordsByType[type]