Options
All
  • Public
  • Public/Protected
  • All
Menu

Module haystack/types

Index

Namespaces

Interfaces

Functions

Functions

isActuator

  • isActuator(value: unknown, namespace?: HNamespace): value is Actuator
  • Returns true if a value is a actuator.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Actuator

    true if the value matches.

isAhu

  • isAhu(value: unknown, namespace?: HNamespace): value is Ahu
  • Returns true if a value is a ahu.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Ahu

    true if the value matches.

isAirHandlingEquip

  • isAirHandlingEquip(value: unknown, namespace?: HNamespace): value is AirHandlingEquip
  • Returns true if a value is a airHandlingEquip.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is AirHandlingEquip

    true if the value matches.

isAirQualityZonePoints

  • Returns true if a value is a airQualityZonePoints.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is AirQualityZonePoints

    true if the value matches.

isAirTerminalUnit

  • isAirTerminalUnit(value: unknown, namespace?: HNamespace): value is AirTerminalUnit
  • Returns true if a value is a airTerminalUnit.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is AirTerminalUnit

    true if the value matches.

isAtes

  • isAtes(value: unknown, namespace?: HNamespace): value is Ates
  • Returns true if a value is a ates.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Ates

    true if the value matches.

isBattery

  • isBattery(value: unknown, namespace?: HNamespace): value is Battery
  • Returns true if a value is a battery.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Battery

    true if the value matches.

isBoiler

  • isBoiler(value: unknown, namespace?: HNamespace): value is Boiler
  • Returns true if a value is a boiler.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Boiler

    true if the value matches.

isCav

  • isCav(value: unknown, namespace?: HNamespace): value is Cav
  • Returns true if a value is a cav.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Cav

    true if the value matches.

isChilledBeam

  • isChilledBeam(value: unknown, namespace?: HNamespace): value is ChilledBeam
  • Returns true if a value is a chilledBeam.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is ChilledBeam

    true if the value matches.

isChiller

  • isChiller(value: unknown, namespace?: HNamespace): value is Chiller
  • Returns true if a value is a chiller.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Chiller

    true if the value matches.

isCircuit

  • isCircuit(value: unknown, namespace?: HNamespace): value is Circuit
  • Returns true if a value is a circuit.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Circuit

    true if the value matches.

isCoil

  • isCoil(value: unknown, namespace?: HNamespace): value is Coil
  • Returns true if a value is a coil.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Coil

    true if the value matches.

isComputer

  • isComputer(value: unknown, namespace?: HNamespace): value is Computer
  • Returns true if a value is a computer.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Computer

    true if the value matches.

isConduit

  • isConduit(value: unknown, namespace?: HNamespace): value is Conduit
  • Returns true if a value is a conduit.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Conduit

    true if the value matches.

isController

  • isController(value: unknown, namespace?: HNamespace): value is Controller
  • Returns true if a value is a controller.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Controller

    true if the value matches.

isCoolingCoil

  • isCoolingCoil(value: unknown, namespace?: HNamespace): value is CoolingCoil
  • Returns true if a value is a coolingCoil.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is CoolingCoil

    true if the value matches.

isCoolingTower

  • isCoolingTower(value: unknown, namespace?: HNamespace): value is CoolingTower
  • Returns true if a value is a coolingTower.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is CoolingTower

    true if the value matches.

isCrac

  • isCrac(value: unknown, namespace?: HNamespace): value is Crac
  • Returns true if a value is a crac.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Crac

    true if the value matches.

isDataCenter

  • isDataCenter(value: unknown, namespace?: HNamespace): value is DataCenter
  • Returns true if a value is a dataCenter.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is DataCenter

    true if the value matches.

isDevice

  • isDevice(value: unknown, namespace?: HNamespace): value is Device
  • Returns true if a value is a device.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Device

    true if the value matches.

isDoas

  • isDoas(value: unknown, namespace?: HNamespace): value is Doas
  • Returns true if a value is a doas.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Doas

    true if the value matches.

isDuct

  • isDuct(value: unknown, namespace?: HNamespace): value is Duct
  • Returns true if a value is a duct.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Duct

    true if the value matches.

isElevator

  • isElevator(value: unknown, namespace?: HNamespace): value is Elevator
  • Returns true if a value is a elevator.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Elevator

    true if the value matches.

isEquip

  • isEquip(value: unknown, namespace?: HNamespace): value is Equip
  • Returns true if a value is a equip.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Equip

    true if the value matches.

isEscalator

  • isEscalator(value: unknown, namespace?: HNamespace): value is Escalator
  • Returns true if a value is a escalator.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Escalator

    true if the value matches.

isFcu

  • isFcu(value: unknown, namespace?: HNamespace): value is Fcu
  • Returns true if a value is a fcu.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Fcu

    true if the value matches.

isFloor

  • isFloor(value: unknown, namespace?: HNamespace): value is Floor
  • Returns true if a value is a floor.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Floor

    true if the value matches.

isFlowInverter

  • isFlowInverter(value: unknown, namespace?: HNamespace): value is FlowInverter
  • Returns true if a value is a flowInverter.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is FlowInverter

    true if the value matches.

isFumeHood

  • isFumeHood(value: unknown, namespace?: HNamespace): value is FumeHood
  • Returns true if a value is a fumeHood.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is FumeHood

    true if the value matches.

isHeatExchanger

  • isHeatExchanger(value: unknown, namespace?: HNamespace): value is HeatExchanger
  • Returns true if a value is a heatExchanger.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is HeatExchanger

    true if the value matches.

isHeatPump

  • isHeatPump(value: unknown, namespace?: HNamespace): value is HeatPump
  • Returns true if a value is a heatPump.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is HeatPump

    true if the value matches.

isHeatingCoil

  • isHeatingCoil(value: unknown, namespace?: HNamespace): value is HeatingCoil
  • Returns true if a value is a heatingCoil.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is HeatingCoil

    true if the value matches.

isHvacZonePoints

  • isHvacZonePoints(value: unknown, namespace?: HNamespace): value is HvacZonePoints
  • Returns true if a value is a hvacZonePoints.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is HvacZonePoints

    true if the value matches.

isLaptop

  • isLaptop(value: unknown, namespace?: HNamespace): value is Laptop
  • Returns true if a value is a laptop.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Laptop

    true if the value matches.

isLightingZonePoints

  • isLightingZonePoints(value: unknown, namespace?: HNamespace): value is LightingZonePoints
  • Returns true if a value is a lightingZonePoints.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is LightingZonePoints

    true if the value matches.

isLuminaire

  • isLuminaire(value: unknown, namespace?: HNamespace): value is Luminaire
  • Returns true if a value is a luminaire.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Luminaire

    true if the value matches.

isMau

  • isMau(value: unknown, namespace?: HNamespace): value is Mau
  • Returns true if a value is a mau.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Mau

    true if the value matches.

isMeter

  • isMeter(value: unknown, namespace?: HNamespace): value is Meter
  • Returns true if a value is a meter.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Meter

    true if the value matches.

isMotor

  • isMotor(value: unknown, namespace?: HNamespace): value is Motor
  • Returns true if a value is a motor.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Motor

    true if the value matches.

isMovingWalkway

  • isMovingWalkway(value: unknown, namespace?: HNamespace): value is MovingWalkway
  • Returns true if a value is a movingWalkway.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is MovingWalkway

    true if the value matches.

isNetwork

  • isNetwork(value: unknown, namespace?: HNamespace): value is Network
  • Returns true if a value is a network.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Network

    true if the value matches.

isPanel

  • isPanel(value: unknown, namespace?: HNamespace): value is Panel
  • Returns true if a value is a panel.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Panel

    true if the value matches.

isPhone

  • isPhone(value: unknown, namespace?: HNamespace): value is Phone
  • Returns true if a value is a phone.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Phone

    true if the value matches.

isPipe

  • isPipe(value: unknown, namespace?: HNamespace): value is Pipe
  • Returns true if a value is a pipe.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Pipe

    true if the value matches.

isPlant

  • isPlant(value: unknown, namespace?: HNamespace): value is Plant
  • Returns true if a value is a plant.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Plant

    true if the value matches.

isPoint

  • isPoint(value: unknown, namespace?: HNamespace): value is Point
  • Returns true if a value is a point.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Point

    true if the value matches.

isPointGroup

  • isPointGroup(value: unknown, namespace?: HNamespace): value is PointGroup
  • Returns true if a value is a pointGroup.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is PointGroup

    true if the value matches.

isRack

  • isRack(value: unknown, namespace?: HNamespace): value is Rack
  • Returns true if a value is a rack.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Rack

    true if the value matches.

isRadiantEquip

  • isRadiantEquip(value: unknown, namespace?: HNamespace): value is RadiantEquip
  • Returns true if a value is a radiantEquip.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is RadiantEquip

    true if the value matches.

isRadiantFloor

  • isRadiantFloor(value: unknown, namespace?: HNamespace): value is RadiantFloor
  • Returns true if a value is a radiantFloor.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is RadiantFloor

    true if the value matches.

isRadiator

  • isRadiator(value: unknown, namespace?: HNamespace): value is Radiator
  • Returns true if a value is a radiator.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Radiator

    true if the value matches.

isRoom

  • isRoom(value: unknown, namespace?: HNamespace): value is Room
  • Returns true if a value is a room.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Room

    true if the value matches.

isRtu

  • isRtu(value: unknown, namespace?: HNamespace): value is Rtu
  • Returns true if a value is a rtu.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Rtu

    true if the value matches.

isSite

  • isSite(value: unknown, namespace?: HNamespace): value is Site
  • Returns true if a value is a site.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Site

    true if the value matches.

isSpace

  • isSpace(value: unknown, namespace?: HNamespace): value is Space
  • Returns true if a value is a space.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Space

    true if the value matches.

isTablet

  • isTablet(value: unknown, namespace?: HNamespace): value is Tablet
  • Returns true if a value is a tablet.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Tablet

    true if the value matches.

isTank

  • isTank(value: unknown, namespace?: HNamespace): value is Tank
  • Returns true if a value is a tank.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Tank

    true if the value matches.

isThermostat

  • isThermostat(value: unknown, namespace?: HNamespace): value is Thermostat
  • Returns true if a value is a thermostat.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Thermostat

    true if the value matches.

isUnitVent

  • isUnitVent(value: unknown, namespace?: HNamespace): value is UnitVent
  • Returns true if a value is a unitVent.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is UnitVent

    true if the value matches.

isUps

  • isUps(value: unknown, namespace?: HNamespace): value is Ups
  • Returns true if a value is a ups.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Ups

    true if the value matches.

isVav

  • isVav(value: unknown, namespace?: HNamespace): value is Vav
  • Returns true if a value is a vav.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Vav

    true if the value matches.

isVerticalTransport

  • isVerticalTransport(value: unknown, namespace?: HNamespace): value is VerticalTransport
  • Returns true if a value is a verticalTransport.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is VerticalTransport

    true if the value matches.

isWeatherStation

  • isWeatherStation(value: unknown, namespace?: HNamespace): value is WeatherStation
  • Returns true if a value is a weatherStation.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is WeatherStation

    true if the value matches.

isWell

  • isWell(value: unknown, namespace?: HNamespace): value is Well
  • Returns true if a value is a well.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Well

    true if the value matches.

isWire

  • isWire(value: unknown, namespace?: HNamespace): value is Wire
  • Returns true if a value is a wire.

    An optional namespace can be passed in that will perform the check using defs.

    Parameters

    • value: unknown

      The value to test.

    • Optional namespace: HNamespace

      An optional namespace.

    Returns value is Wire

    true if the value matches.

Generated using TypeDoc