VolumeInterrogatorBase

VolumeInterrogatorBaseModule. VolumeInterrogatorBase

new VolumeInterrogatorBase(configopt)

Description:

  • Base class for volume interrogation (operating system agnostic).

Source:
Parameters:
Name Type Attributes Description
config object <optional>

The settings to use for creating the object.

Properties
Name Type Attributes Description
period_hr number <optional>

The time (in hours) for periodically interrogating the system.
default_alarm_threshold number <optional>

The default low space threshold, in percent.
volume_customizations Array.<object> <optional>

Array of objects for per-volume customizations.

Properties
Name Type Attributes Description
volume_id_method VOLUME_IDENTIFICATION_METHODS <optional>

The method for identifying the volume.
volume_name string <optional>

The name of the volume (required when config.volume_customizations.volume_id_method === VOLUME_IDENTIFICATION_METHODS.Name)
volume_serial_num string <optional>

The serial number of the volume (required when config.volume_customizations.volume_id_method === VOLUME_IDENTIFICATION_METHODS.SerialNumber)
volume_low_space_alarm_active boolean <optional>

The flag indicating if the low space alarm is active or not.
volume_alarm_threshold number <optional>

The low space threshold, in percent (required when config.volume_customizations.volume_low_space_alarm_active === true)
Throws:
    • thrown if the configuration item is not the expected type.
    Type
    TypeError
    • thrown if the configuration parameters are out of bounds.
    Type
    RangeError

Extends

  • EventEmitter

Members

Active

Description:

  • Read-Only Property accessor indicating if the checking of volume data is active.

Source:

Read-Only Property accessor indicating if the checking of volume data is active.

MaximumPeriod

Description:

  • Read-Only Property accessor for the maximum period

Source:

Read-Only Property accessor for the maximum period

MinimumPeriod

Description:

  • Read-Only Property accessor for the minumum period

Source:

Read-Only Property accessor for the minumum period

Period

Description:

  • Read Property accessor for the interrogation period.

Source:

Read Property accessor for the interrogation period.

Period

Description:

  • Write Property accessor for the interrogation period.

Source:

Write Property accessor for the interrogation period.

Methods

Start() → {void}

Description:

  • Starts/Restart the interrogation process.

Source:
Returns:
Type
void

Stop() → {void}

Description:

  • Stop the interrogation process.

Source:
Returns:
Type
void

Terminate() → {void}

Description:

  • Destructor

Source:
Returns:
Type
void

_handleVolumeWatcherAdded(result) → {void}

Description:

  • Event handler for file system change detections. Called when the contents of the watched folder(s) change(s).

Source:
Parameters:
Name Type Description
result object

Result of the request to add a watcher.

Properties
Name Type Description
target string

Target of the watch
success boolean

Status of the add operation.
Returns:
Type
void

(static) _validateVolumeExclusionMask(maskConfig) → {boolean}

Description:

  • Helper to evaluate the validity of the volume exclusion configuration.

Source:
Parameters:
Name Type Description
maskConfig object

Volume exclusion mask.
Returns:
  • true if the exclusion mask is valid. false otherwise.
Type
boolean