Class SchemaUnitClass

SchemaUnitClass class

Hierarchy (View Summary)

SchemaEntryWithAttributes
- SchemaUnitClass

Index

Constructors

Properties

_name _units booleanAttributeNames booleanAttributes valueAttributeNames valueAttributes

Accessors

defaultUnit name units

Methods

_memoize extractUnit getAttributeValue hasAttribute hasBooleanAttribute

Constructors

constructor

new SchemaUnitClass(
    name: string,
    booleanAttributes: Set<SchemaAttribute>,
    valueAttributes: Map<SchemaAttribute, any>,
    units: Map<string, SchemaUnit>,
): SchemaUnitClass
Constructor.
Parameters
- name: string
  The name of this unit class.
- booleanAttributes: Set<SchemaAttribute>
  The boolean attributes for this unit class.
- valueAttributes: Map<SchemaAttribute, any>
  The value attributes for this unit class.
- units: Map<string, SchemaUnit>
  The units for this unit class.
Returns SchemaUnitClass
Overrides SchemaEntryWithAttributes.constructor
- Defined in src/schema/entries.js:547

Properties

_name

_name: string

The name of this schema entry.

_units

_units: Map<string, SchemaUnit>

The units for this unit class.

booleanAttributeNames

booleanAttributeNames: Set<string>

The set of boolean attribute names this schema entry has.

booleanAttributes

booleanAttributes: Set<SchemaAttribute>

The set of boolean attributes this schema entry has.

valueAttributeNames

valueAttributeNames: Map<string, any>

The collection of value attribute names this schema entry has.

valueAttributes

valueAttributes: Map<SchemaAttribute, any>

The collection of value attributes this schema entry has.

Accessors

defaultUnit

get defaultUnit(): SchemaUnit
Get the default unit for this unit class.

Returns SchemaUnit
- Defined in src/schema/entries.js:564

name

get name(): string
The name of this schema entry.

Returns string
Inherited from SchemaEntryWithAttributes.name
- Defined in src/schema/entries.js:199

units

get units(): Map<string, SchemaUnit>
Get the units for this unit class.

Returns Map<string, SchemaUnit>
- Defined in src/schema/entries.js:556

Methods

`Protected`_memoize

_memoize<T>(propertyName: string, valueComputer: () => T): T
Protected
Memoize a property.
Type Parameters
- T
Parameters
- propertyName: string
  The property name.
- valueComputer: () => T
  A function to compute the property's value.
Returns T
The computed value.
Inherited from SchemaEntryWithAttributes._memoize
- Defined in src/utils/memoizer.js:33

extractUnit

extractUnit(value: any): any[]
Extracts the Unit class and remainder
Parameters
- value: any
Returns any[]
[SchemaUnit, string, string] containing unit class, unit string, and value string
- Defined in src/schema/entries.js:572

getAttributeValue

getAttributeValue(attributeName: string, alwaysReturnArray?: boolean): any
Retrieve the value of a value attribute (by name) on this schema entry.
Parameters
- attributeName: string
  The attribute whose value should be returned.
- alwaysReturnArray: boolean = false
  Whether to return a singleton array instead of a scalar value.
Returns any
The value of the attribute.
Inherited from SchemaEntryWithAttributes.getAttributeValue
- Defined in src/schema/entries.js:415

hasAttribute

hasAttribute(attributeName: string): boolean
Whether this schema entry has this attribute (by name).
Parameters
- attributeName: string
  The attribute to check for.
Returns boolean
Whether this schema entry has this attribute.
Inherited from SchemaEntryWithAttributes.hasAttribute
- Defined in src/schema/entries.js:396

hasBooleanAttribute

hasBooleanAttribute(attributeName: string): boolean
Whether this schema entry has this boolean attribute (by name).
Parameters
- attributeName: string
  The attribute to check for.
Returns boolean
Whether this schema entry has this attribute.
Inherited from SchemaEntryWithAttributes.hasBooleanAttribute
- Defined in src/schema/entries.js:405