src/data/composite/wiki-properties/flag.js


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

// Straightforward flag descriptor for a variety of property purposes.
// Provide a default value, true or false!

import {isBoolean} from '#validators';

// TODO: Not templateCompositeFrom.

// TODO: The description is a lie. This defaults to false. Bad.

export default function(defaultValue = false) {
  if (typeof defaultValue !== 'boolean') {
    throw new TypeError(`Always set explicit defaults for flags!`);
  }

  return {
    flags: {update: true, expose: true},
    update: {validate: isBoolean, default: defaultValue},
  };
}