Prefer Annotating Types Over Asserting

[JNygaard-Skylight]

PULL REQUEST

Summary

Where possible, annotate the returned value of the evaluate function instead of asserting it.

Related Issue

Fixes # n/a

Acceptance Criteria

n/a

Additional Information

We use the evaluate function from the fhirpath library throughout. the ecr-viewer. However, it is typed to return any. To take advantage of type hints in IDEs, we need to either assert the expected type, e.g., const rrDetails: Observation[] = evaluate(fhirBundle, mappings.rrDetails); or assert the expected type, e.g., const rrDetails = evaluate(fhirBundle, mappings.rrDetails) as Observation[];. Both options more-or-less do the same thing, but there are a few reasons to prefer annotation. In brief it is the difference between saying, "I know the type of this value, and throw an error if it does not fit this type," and "Treat this value as this type no matter what."

See:

• https://stackoverflow.com/questions/47994926/detailed-differences-between-type-annotation-variable-type-and-type-assertion
• https://medium.com/@bsalwiczek/type-annotation-vs-assertion-in-typescript-one-important-difference-4f4df715b5fe

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.67%. Comparing base (2bd0e03) to head (d1ff026).

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3042      +/-   ##
==========================================
- Coverage   86.00%   85.67%   -0.34%     
==========================================
  Files         162       25     -137     
  Lines       10855     1424    -9431     
==========================================
- Hits         9336     1220    -8116     
+ Misses       1519      204    -1315     

Flag	Coverage Δ
fhir-converter	?
ingestion	?
message-parser	?
message-refiner	?
orchestration	85.67% <ø> (ø)
record-linkage	?
trigger-code-reference	?
validation	?

Flags with carried forward coverage won't be shown. Click here to find out more.

see 137 files with indirect coverage changes