Wbs

This class holds a WBS (Work Breakdown Structure) value (e.g., '1.2.1'). This class ensures that such values compare correctly, for example, that '1.2' is less than '1.10' (which do not compare that way as simple text). Use the static from() method to create instances and compare() for ordering.

const wbs = Wbs.from('1.2.10');

// Correct numeric ordering (not lexicographic)
Wbs.compare('1.2', '1.10'); // -1 (1.2 < 1.10)
Wbs.compare('2.1', '1.3');  // 1  (2.1 > 1.3)

Properties

Properties are getters/setters or publicly accessible variables on this class

value : String

READONLY

The WBS value

Functions

Functions are methods available for calling on the class

compare( lhs, rhs )
: Number

static

Compares two WBS values, returning 0 if equal, -1 if lhs is less than rhs, or 1 if lhsis greater thanrhs`.
from( value )
: Wbs

static

Returns a Wbs instance given a value. If the value is already a Wbs object, it is returned. Otherwise, a new Wbs is created. If value is null or undefined, that value is returned.
pad( value )
: String

private

static

Returns a WBS code where each component is 0-padded on the left to 6 digits. That is "1.2" is padded to be "000001.000002". These values can be compared for proper semantic order (e.g., Wbs.pad('1.2') < Wbs.pad('1.10')).
split( value )
: Number[]

private

static

Returns an array of digits from a given WBS code value. If the value cannot be converted, an empty array is returned.

append( value )
: Wbs

Appends a sub-level WBS value to this WBS code and returns a Wbs instance for it.
isEqual( value )
: Boolean

Returns truthy value if this Wbs equals the passed value.
match( pattern )
: Boolean
Compares this WBS value with a specified pattern, returning true if they match. If the pattern is simply a sequence of digits and decimal points (e.g., "1.2"), it is a match if it is a substring of this WBS code (e.g., "3.1.2.4"). If the pattern starts with * (e.g., "*.1.2"), it is a match if this WBS code ends with the text following the * (e.g., "4.3.1.2"). If the pattern ends with *, it is a match if this WBS code starts with the text up to the *.

Some examples:
```
 console.log(Wbs.from('1.2.3.4').match('2.3'));
 > true
 console.log(Wbs.from('1.2.3.4').match('*.4'));
 > true
 console.log(Wbs.from('1.2.3.4').match('1.2.*'));
 > true

 console.log(Wbs.from('1.2.3.4').match('2.4'));
 > false
 console.log(Wbs.from('1.2.3.4').match('*.3'));
 > false
 console.log(Wbs.from('1.2.3.4').match('2.*'));
 > false
```

Source path

Core/data/Wbs.js

Wbs

See also

Properties

Functions

Source path

Inheritance tree1

Contents