src/thing/thing.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

// Base class for Things. No, we will not come up with a better name.
// Sorry not sorry! :)
//
// NB: Since these methods all involve processing a variety of input data, some
// of which will pass and some of which may fail, any failures should be thrown
// together as an AggregateError. See util/sugar.js for utility functions to
// make writing code around this easier!

import CacheableObject from './cacheable-object.js';

export default class Thing extends CacheableObject {
    static propertyDescriptors = Symbol('Thing property descriptors');

    // Called when collecting the full list of available things of that type
    // for wiki data; this method determine whether or not to include it.
    //
    // This should return whether or not the object is complete enough to be
    // used across the wiki - not whether every optional attribute is provided!
    // (That is, attributes required for postprocessing & basic page generation
    // are all present.)
    checkComplete() {}

    // Called when adding the thing to the wiki data list, and when its source
    // data is updated (provided checkComplete() passes).
    //
    // This should generate any cached object references, across other wiki
    // data; for example, building an array of actual track objects
    // corresponding to an album's track list ('track:cool-track' strings).
    postprocess({wikiData}) {}
}