# API reference

> Functions, classes and types exported by @welldot/core.

## Functions

- [calculatedWellDepth](/core/api/functions/calculatedWellDepth)
- [compareFormatVersions](/core/api/functions/compareFormatVersions)
- [concentrationFromCanonical](/core/api/functions/concentrationFromCanonical)
- [concentrationToCanonical](/core/api/functions/concentrationToCanonical)
- [cubicFeetToCubicMeters](/core/api/functions/cubicFeetToCubicMeters)
- [cubicMeterPerHourToLitersPerSecond](/core/api/functions/cubicMeterPerHourToLitersPerSecond)
- [cubicMeterPerHourToUsGallonsPerMinute](/core/api/functions/cubicMeterPerHourToUsGallonsPerMinute)
- [cubicMetersToCubicFeet](/core/api/functions/cubicMetersToCubicFeet)
- [cubicMetersToLiters](/core/api/functions/cubicMetersToLiters)
- [cubicMetersToUsGallons](/core/api/functions/cubicMetersToUsGallons)
- [cvToKilowatts](/core/api/functions/cvToKilowatts)
- [decimalDegreesToDms](/core/api/functions/decimalDegreesToDms)
- [deserializeWell](/core/api/functions/deserializeWell)
- [dmsToDecimalDegrees](/core/api/functions/dmsToDecimalDegrees)
- [expandedToStandardUncertainty](/core/api/functions/expandedToStandardUncertainty)
- [feetToMeters](/core/api/functions/feetToMeters)
- [flowFromCanonical](/core/api/functions/flowFromCanonical)
- [flowToCanonical](/core/api/functions/flowToCanonical)
- [formatVocabList](/core/api/functions/formatVocabList)
- [getLimitSet](/core/api/functions/getLimitSet)
- [getParameterDefinition](/core/api/functions/getParameterDefinition)
- [getParameterLabel](/core/api/functions/getParameterLabel)
- [getVocabEntry](/core/api/functions/getVocabEntry)
- [getVocabLabel](/core/api/functions/getVocabLabel)
- [hasWellData](/core/api/functions/hasWellData)
- [hoursToMinutes](/core/api/functions/hoursToMinutes)
- [hpToKilowatts](/core/api/functions/hpToKilowatts)
- [inchesToMm](/core/api/functions/inchesToMm)
- [isIanaTimeZone](/core/api/functions/isIanaTimeZone)
- [isKnownParameter](/core/api/functions/isKnownParameter)
- [isVocabValue](/core/api/functions/isVocabValue)
- [isWellEmpty](/core/api/functions/isWellEmpty)
- [kilopascalToPsi](/core/api/functions/kilopascalToPsi)
- [kilowattsToCv](/core/api/functions/kilowattsToCv)
- [kilowattsToHp](/core/api/functions/kilowattsToHp)
- [litersPerSecondToCubicMeterPerHour](/core/api/functions/litersPerSecondToCubicMeterPerHour)
- [litersToCubicMeters](/core/api/functions/litersToCubicMeters)
- [metersToFeet](/core/api/functions/metersToFeet)
- [milliSiemensPerCmToMicroSiemensPerCm](/core/api/functions/milliSiemensPerCmToMicroSiemensPerCm)
- [milliSiemensPerMeterToMicroSiemensPerCm](/core/api/functions/milliSiemensPerMeterToMicroSiemensPerCm)
- [minutesToHours](/core/api/functions/minutesToHours)
- [mmToInches](/core/api/functions/mmToInches)
- [mmToSlotNumber](/core/api/functions/mmToSlotNumber)
- [normalizeColorUnit](/core/api/functions/normalizeColorUnit)
- [parameterKey](/core/api/functions/parameterKey)
- [parseFormatVersion](/core/api/functions/parseFormatVersion)
- [parseWell](/core/api/functions/parseWell)
- [powerFromCanonical](/core/api/functions/powerFromCanonical)
- [powerToCanonical](/core/api/functions/powerToCanonical)
- [psiToKilopascal](/core/api/functions/psiToKilopascal)
- [redactWell](/core/api/functions/redactWell)
- [resolveLanguageText](/core/api/functions/resolveLanguageText)
- [serializeWell](/core/api/functions/serializeWell)
- [slotNumberToMm](/core/api/functions/slotNumberToMm)
- [squareMeterPerDayToSquareMeterPerSecond](/core/api/functions/squareMeterPerDayToSquareMeterPerSecond)
- [squareMeterPerSecondToSquareMeterPerDay](/core/api/functions/squareMeterPerSecondToSquareMeterPerDay)
- [turbidityCodeForUnit](/core/api/functions/turbidityCodeForUnit)
- [usGallonsPerMinuteToCubicMeterPerHour](/core/api/functions/usGallonsPerMinuteToCubicMeterPerHour)
- [usGallonsToCubicMeters](/core/api/functions/usGallonsToCubicMeters)
- [vocabValues](/core/api/functions/vocabValues)
- [volumeFromCanonical](/core/api/functions/volumeFromCanonical)
- [volumeToCanonical](/core/api/functions/volumeToCanonical)

## Type Aliases

- [AirliftEvent](/core/api/type-aliases/AirliftEvent)
- [AquiferAnalysis](/core/api/type-aliases/AquiferAnalysis)
- [AquiferAnalysisMethod](/core/api/type-aliases/AquiferAnalysisMethod)
- [Attachment](/core/api/type-aliases/Attachment)
- [AttachmentDocumentType](/core/api/type-aliases/AttachmentDocumentType)
- [BarometricCompensation](/core/api/type-aliases/BarometricCompensation)
- [BoreHole](/core/api/type-aliases/BoreHole)
- [Cave](/core/api/type-aliases/Cave)
- [CementPad](/core/api/type-aliases/CementPad)
- [CementPadType](/core/api/type-aliases/CementPadType)
- [Centralizer](/core/api/type-aliases/Centralizer)
- [CentralizerType](/core/api/type-aliases/CentralizerType)
- [ConcentrationUnits](/core/api/type-aliases/ConcentrationUnits)
- [ConditionCategory](/core/api/type-aliases/ConditionCategory)
- [ConditionFulfillment](/core/api/type-aliases/ConditionFulfillment)
- [ConstantRateEvent](/core/api/type-aliases/ConstantRateEvent)
- [ConstructionMaterial](/core/api/type-aliases/ConstructionMaterial)
- [Constructive](/core/api/type-aliases/Constructive)
- [DiameterUnits](/core/api/type-aliases/DiameterUnits)
- [DmsCoordinate](/core/api/type-aliases/DmsCoordinate)
- [DocumentTypeContext](/core/api/type-aliases/DocumentTypeContext)
- [DrillingMethod](/core/api/type-aliases/DrillingMethod)
- [EstimatedVolume](/core/api/type-aliases/EstimatedVolume)
- [EstimationMethod](/core/api/type-aliases/EstimationMethod)
- [Filtration](/core/api/type-aliases/Filtration)
- [FlowUnits](/core/api/type-aliases/FlowUnits)
- [FormatVersion](/core/api/type-aliases/FormatVersion)
- [Fracture](/core/api/type-aliases/Fracture)
- [Geologic](/core/api/type-aliases/Geologic)
- [HistoryLogCategory](/core/api/type-aliases/HistoryLogCategory)
- [HistoryLogEntry](/core/api/type-aliases/HistoryLogEntry)
- [HistoryLogSeverity](/core/api/type-aliases/HistoryLogSeverity)
- [HoleFill](/core/api/type-aliases/HoleFill)
- [HydrodynamicEvent](/core/api/type-aliases/HydrodynamicEvent)
- [HydrodynamicEventBase](/core/api/type-aliases/HydrodynamicEventBase)
- [Laboratory](/core/api/type-aliases/Laboratory)
- [LanguageText](/core/api/type-aliases/LanguageText)
- [LanguageTextInput](/core/api/type-aliases/LanguageTextInput)
- [LengthUnits](/core/api/type-aliases/LengthUnits)
- [LevelReading](/core/api/type-aliases/LevelReading)
- [Limit](/core/api/type-aliases/Limit)
- [LimitBasis](/core/api/type-aliases/LimitBasis)
- [LimitSet](/core/api/type-aliases/LimitSet)
- [Lithology](/core/api/type-aliases/Lithology)
- [Location](/core/api/type-aliases/Location)
- [LocationProperties](/core/api/type-aliases/LocationProperties)
- [LoggerReading](/core/api/type-aliases/LoggerReading)
- [LoggerSeriesEvent](/core/api/type-aliases/LoggerSeriesEvent)
- [MaintenanceType](/core/api/type-aliases/MaintenanceType)
- [MeasurementMethod](/core/api/type-aliases/MeasurementMethod)
- [Meter](/core/api/type-aliases/Meter)
- [MeterReading](/core/api/type-aliases/MeterReading)
- [MeterType](/core/api/type-aliases/MeterType)
- [MonthlyGrant](/core/api/type-aliases/MonthlyGrant)
- [OpenVocab](/core/api/type-aliases/OpenVocab)
- [OperatingRegime](/core/api/type-aliases/OperatingRegime)
- [Parameter](/core/api/type-aliases/Parameter)
- [ParameterDefinition](/core/api/type-aliases/ParameterDefinition)
- [ParameterForm](/core/api/type-aliases/ParameterForm)
- [ParameterGroup](/core/api/type-aliases/ParameterGroup)
- [ParameterUnit](/core/api/type-aliases/ParameterUnit)
- [Permit](/core/api/type-aliases/Permit)
- [PermitAdministrativeStatus](/core/api/type-aliases/PermitAdministrativeStatus)
- [PermitCondition](/core/api/type-aliases/PermitCondition)
- [PermitHistoryEntry](/core/api/type-aliases/PermitHistoryEntry)
- [PermitHistoryType](/core/api/type-aliases/PermitHistoryType)
- [PermitType](/core/api/type-aliases/PermitType)
- [PowerSource](/core/api/type-aliases/PowerSource)
- [PowerUnits](/core/api/type-aliases/PowerUnits)
- [ProductionEntry](/core/api/type-aliases/ProductionEntry)
- [ProductionEntryBase](/core/api/type-aliases/ProductionEntryBase)
- [PumpElectrical](/core/api/type-aliases/PumpElectrical)
- [PumpingStep](/core/api/type-aliases/PumpingStep)
- [PumpInstallation](/core/api/type-aliases/PumpInstallation)
- [PumpType](/core/api/type-aliases/PumpType)
- [Purge](/core/api/type-aliases/Purge)
- [PurgeReading](/core/api/type-aliases/PurgeReading)
- [ReadingAggregation](/core/api/type-aliases/ReadingAggregation)
- [ReadingSource](/core/api/type-aliases/ReadingSource)
- [RecoveryOnlyEvent](/core/api/type-aliases/RecoveryOnlyEvent)
- [RecoveryPhase](/core/api/type-aliases/RecoveryPhase)
- [Reduction](/core/api/type-aliases/Reduction)
- [ResultQualifier](/core/api/type-aliases/ResultQualifier)
- [ResultValidation](/core/api/type-aliases/ResultValidation)
- [SampleType](/core/api/type-aliases/SampleType)
- [SamplingDevice](/core/api/type-aliases/SamplingDevice)
- [SamplingMethod](/core/api/type-aliases/SamplingMethod)
- [SamplingPoint](/core/api/type-aliases/SamplingPoint)
- [SamplingPointType](/core/api/type-aliases/SamplingPointType)
- [ScreenSlotType](/core/api/type-aliases/ScreenSlotType)
- [SectionKey](/core/api/type-aliases/SectionKey)
- [SectionVisibility](/core/api/type-aliases/SectionVisibility)
- [SpotMeasurementEvent](/core/api/type-aliases/SpotMeasurementEvent)
- [StepDrawdownEvent](/core/api/type-aliases/StepDrawdownEvent)
- [SurfaceCase](/core/api/type-aliases/SurfaceCase)
- [Texture](/core/api/type-aliases/Texture)
- [TextureCode](/core/api/type-aliases/TextureCode)
- [TextureOption](/core/api/type-aliases/TextureOption)
- [TimeResolution](/core/api/type-aliases/TimeResolution)
- [Units](/core/api/type-aliases/Units)
- [UnitsTypes](/core/api/type-aliases/UnitsTypes)
- [VisibilityFieldKey](/core/api/type-aliases/VisibilityFieldKey)
- [VisibilityKey](/core/api/type-aliases/VisibilityKey)
- [VocabEntry](/core/api/type-aliases/VocabEntry)
- [VolumeLimit](/core/api/type-aliases/VolumeLimit)
- [VolumeUnits](/core/api/type-aliases/VolumeUnits)
- [WaterQualityResult](/core/api/type-aliases/WaterQualityResult)
- [WaterSample](/core/api/type-aliases/WaterSample)
- [WaterUse](/core/api/type-aliases/WaterUse)
- [Well](/core/api/type-aliases/Well)
- [WellCase](/core/api/type-aliases/WellCase)
- [WellId](/core/api/type-aliases/WellId)
- [WellPurpose](/core/api/type-aliases/WellPurpose)
- [WellScreen](/core/api/type-aliases/WellScreen)
- [WellStatus](/core/api/type-aliases/WellStatus)
- [WellType](/core/api/type-aliases/WellType)
- [WellVisibility](/core/api/type-aliases/WellVisibility)

## Variables

- [AirliftEventSchema](/core/api/variables/AirliftEventSchema)
- [AQUIFER\_ANALYSIS\_METHODS](/core/api/variables/AQUIFER_ANALYSIS_METHODS)
- [AquiferAnalysisSchema](/core/api/variables/AquiferAnalysisSchema)
- [AttachmentSchema](/core/api/variables/AttachmentSchema)
- [BAROMETRIC\_COMPENSATION\_VALUES](/core/api/variables/BAROMETRIC_COMPENSATION_VALUES)
- [BAROMETRIC\_COMPENSATIONS](/core/api/variables/BAROMETRIC_COMPENSATIONS)
- [BLANK\_SAMPLE\_TYPES](/core/api/variables/BLANK_SAMPLE_TYPES)
- [BoreHoleSchema](/core/api/variables/BoreHoleSchema)
- [BR\_GM\_MS\_888\_2021](/core/api/variables/BR_GM_MS_888_2021)
- [CaveSchema](/core/api/variables/CaveSchema)
- [CEMENT\_PAD\_TYPES](/core/api/variables/CEMENT_PAD_TYPES)
- [CementPadSchema](/core/api/variables/CementPadSchema)
- [CENTRALIZER\_TYPES](/core/api/variables/CENTRALIZER_TYPES)
- [CentralizerSchema](/core/api/variables/CentralizerSchema)
- [~~checkIfProfileIsEmpty~~](/core/api/variables/checkIfProfileIsEmpty)
- [CONDITION\_CATEGORIES](/core/api/variables/CONDITION_CATEGORIES)
- [ConditionFulfillmentSchema](/core/api/variables/ConditionFulfillmentSchema)
- [ConstantRateEventSchema](/core/api/variables/ConstantRateEventSchema)
- [CONSTRUCTION\_MATERIALS](/core/api/variables/CONSTRUCTION_MATERIALS)
- [~~convertProfileFromJSON~~](/core/api/variables/convertProfileFromJSON)
- [DOCUMENT\_TYPE\_SUGGESTIONS](/core/api/variables/DOCUMENT_TYPE_SUGGESTIONS)
- [DOCUMENT\_TYPES](/core/api/variables/DOCUMENT_TYPES)
- [DRILLING\_METHODS](/core/api/variables/DRILLING_METHODS)
- [EstimatedVolumeSchema](/core/api/variables/EstimatedVolumeSchema)
- [ESTIMATION\_METHODS](/core/api/variables/ESTIMATION_METHODS)
- [EU\_2020\_2184](/core/api/variables/EU_2020_2184)
- [FGDC\_TEXTURES\_OPTIONS](/core/api/variables/FGDC_TEXTURES_OPTIONS)
- [FILTRATION\_LOCATION\_VALUES](/core/api/variables/FILTRATION_LOCATION_VALUES)
- [FiltrationSchema](/core/api/variables/FiltrationSchema)
- [FRACTION\_VALUES](/core/api/variables/FRACTION_VALUES)
- [FractureSchema](/core/api/variables/FractureSchema)
- [HISTORY\_LOG\_CATEGORIES](/core/api/variables/HISTORY_LOG_CATEGORIES)
- [HISTORY\_LOG\_SEVERITIES](/core/api/variables/HISTORY_LOG_SEVERITIES)
- [HistoryLogEntrySchema](/core/api/variables/HistoryLogEntrySchema)
- [HoleFillSchema](/core/api/variables/HoleFillSchema)
- [HYDRODYNAMIC\_EVENT\_TYPES](/core/api/variables/HYDRODYNAMIC_EVENT_TYPES)
- [HydrodynamicEventBaseSchema](/core/api/variables/HydrodynamicEventBaseSchema)
- [HydrodynamicEventSchema](/core/api/variables/HydrodynamicEventSchema)
- [LaboratorySchema](/core/api/variables/LaboratorySchema)
- [LevelReadingSchema](/core/api/variables/LevelReadingSchema)
- [LithologySchema](/core/api/variables/LithologySchema)
- [LocationPropertiesSchema](/core/api/variables/LocationPropertiesSchema)
- [LocationSchema](/core/api/variables/LocationSchema)
- [LoggerReadingSchema](/core/api/variables/LoggerReadingSchema)
- [LoggerSeriesEventSchema](/core/api/variables/LoggerSeriesEventSchema)
- [MAINTENANCE\_TYPES](/core/api/variables/MAINTENANCE_TYPES)
- [MEASURED\_IN\_VALUES](/core/api/variables/MEASURED_IN_VALUES)
- [MEASUREMENT\_LOCATIONS](/core/api/variables/MEASUREMENT_LOCATIONS)
- [MEASUREMENT\_METHODS](/core/api/variables/MEASUREMENT_METHODS)
- [METER\_TYPES](/core/api/variables/METER_TYPES)
- [MeterReadingSchema](/core/api/variables/MeterReadingSchema)
- [MeterSchema](/core/api/variables/MeterSchema)
- [MonthlyGrantSchema](/core/api/variables/MonthlyGrantSchema)
- [NEPHELOMETRIC\_TURBIDITY\_CODES](/core/api/variables/NEPHELOMETRIC_TURBIDITY_CODES)
- [NUMERIC\_QUALIFIERS](/core/api/variables/NUMERIC_QUALIFIERS)
- [OperatingRegimeSchema](/core/api/variables/OperatingRegimeSchema)
- [PARAMETER\_GROUP\_VALUES](/core/api/variables/PARAMETER_GROUP_VALUES)
- [PARAMETER\_GROUPS](/core/api/variables/PARAMETER_GROUPS)
- [ParameterSchema](/core/api/variables/ParameterSchema)
- [PARENT\_SAMPLE\_TYPES](/core/api/variables/PARENT_SAMPLE_TYPES)
- [PERMIT\_ADMINISTRATIVE\_STATUS\_VALUES](/core/api/variables/PERMIT_ADMINISTRATIVE_STATUS_VALUES)
- [PERMIT\_ADMINISTRATIVE\_STATUSES](/core/api/variables/PERMIT_ADMINISTRATIVE_STATUSES)
- [PERMIT\_HISTORY\_TYPES](/core/api/variables/PERMIT_HISTORY_TYPES)
- [PERMIT\_TYPES](/core/api/variables/PERMIT_TYPES)
- [PermitAdministrativeStatusSchema](/core/api/variables/PermitAdministrativeStatusSchema)
- [PermitConditionSchema](/core/api/variables/PermitConditionSchema)
- [PermitHistoryEntrySchema](/core/api/variables/PermitHistoryEntrySchema)
- [PermitSchema](/core/api/variables/PermitSchema)
- [POWER\_SOURCES](/core/api/variables/POWER_SOURCES)
- [PRODUCTION\_ENTRY\_TYPES](/core/api/variables/PRODUCTION_ENTRY_TYPES)
- [ProductionEntryBaseSchema](/core/api/variables/ProductionEntryBaseSchema)
- [ProductionEntrySchema](/core/api/variables/ProductionEntrySchema)
- [~~profileToWell~~](/core/api/variables/profileToWell)
- [PUMP\_TYPES](/core/api/variables/PUMP_TYPES)
- [PumpElectricalSchema](/core/api/variables/PumpElectricalSchema)
- [PumpingStepSchema](/core/api/variables/PumpingStepSchema)
- [PumpInstallationSchema](/core/api/variables/PumpInstallationSchema)
- [PurgeReadingSchema](/core/api/variables/PurgeReadingSchema)
- [PurgeSchema](/core/api/variables/PurgeSchema)
- [QUALIFIER\_VALUES](/core/api/variables/QUALIFIER_VALUES)
- [READING\_AGGREGATION\_VALUES](/core/api/variables/READING_AGGREGATION_VALUES)
- [READING\_AGGREGATIONS](/core/api/variables/READING_AGGREGATIONS)
- [READING\_SOURCES](/core/api/variables/READING_SOURCES)
- [RecoveryOnlyEventSchema](/core/api/variables/RecoveryOnlyEventSchema)
- [RecoveryPhaseSchema](/core/api/variables/RecoveryPhaseSchema)
- [ReductionSchema](/core/api/variables/ReductionSchema)
- [RESULT\_FRACTIONS](/core/api/variables/RESULT_FRACTIONS)
- [RESULT\_QUALIFIERS](/core/api/variables/RESULT_QUALIFIERS)
- [ResultQualifierSchema](/core/api/variables/ResultQualifierSchema)
- [ResultValidationSchema](/core/api/variables/ResultValidationSchema)
- [SAMPLE\_TYPES](/core/api/variables/SAMPLE_TYPES)
- [SAMPLING\_DEVICES](/core/api/variables/SAMPLING_DEVICES)
- [SAMPLING\_METHODS](/core/api/variables/SAMPLING_METHODS)
- [SAMPLING\_POINT\_TYPES](/core/api/variables/SAMPLING_POINT_TYPES)
- [SamplingPointSchema](/core/api/variables/SamplingPointSchema)
- [SCREEN\_SLOT\_TYPES](/core/api/variables/SCREEN_SLOT_TYPES)
- [SECTION\_KEYS](/core/api/variables/SECTION_KEYS)
- [SpotMeasurementEventSchema](/core/api/variables/SpotMeasurementEventSchema)
- [StepDrawdownEventSchema](/core/api/variables/StepDrawdownEventSchema)
- [SurfaceCaseSchema](/core/api/variables/SurfaceCaseSchema)
- [TextureSchema](/core/api/variables/TextureSchema)
- [TimeResolutionSchema](/core/api/variables/TimeResolutionSchema)
- [VALIDATION\_STATUS\_VALUES](/core/api/variables/VALIDATION_STATUS_VALUES)
- [VALIDATION\_STATUSES](/core/api/variables/VALIDATION_STATUSES)
- [VISIBILITY\_LEAF\_KEYS](/core/api/variables/VISIBILITY_LEAF_KEYS)
- [VISIBILITY\_TREE](/core/api/variables/VISIBILITY_TREE)
- [VOLUME\_LIMIT\_PERIODS](/core/api/variables/VOLUME_LIMIT_PERIODS)
- [VolumeLimitSchema](/core/api/variables/VolumeLimitSchema)
- [WATER\_QUALITY\_LIMIT\_SETS](/core/api/variables/WATER_QUALITY_LIMIT_SETS)
- [WATER\_QUALITY\_PARAMETERS](/core/api/variables/WATER_QUALITY_PARAMETERS)
- [WATER\_QUALITY\_UNITS](/core/api/variables/WATER_QUALITY_UNITS)
- [WATER\_QUALITY\_VOCABULARY\_VERSION](/core/api/variables/WATER_QUALITY_VOCABULARY_VERSION)
- [WATER\_USES](/core/api/variables/WATER_USES)
- [WaterQualityResultSchema](/core/api/variables/WaterQualityResultSchema)
- [WaterSampleSchema](/core/api/variables/WaterSampleSchema)
- [WELL\_FORMAT\_VERSION](/core/api/variables/WELL_FORMAT_VERSION)
- [WELL\_PURPOSES](/core/api/variables/WELL_PURPOSES)
- [WELL\_STATUS\_VALUES](/core/api/variables/WELL_STATUS_VALUES)
- [WELL\_STATUSES](/core/api/variables/WELL_STATUSES)
- [WELL\_TYPES](/core/api/variables/WELL_TYPES)
- [WellCaseSchema](/core/api/variables/WellCaseSchema)
- [WellIdSchema](/core/api/variables/WellIdSchema)
- [WellSchema](/core/api/variables/WellSchema)
- [WellScreenSchema](/core/api/variables/WellScreenSchema)
- [WellStatusSchema](/core/api/variables/WellStatusSchema)
- [WHO\_GDWQ\_2022](/core/api/variables/WHO_GDWQ_2022)

## References

### Profile

Renames and re-exports [Well](/core/api/type-aliases/Well)