projecttacoma / fqm-execution

fqm-execution is a library that allows users to calculate FHIR-based electronic Clinical Quality Measures (eCQMs) and retrieve the results in a variety of formats
https://projecttacoma.github.io/fqm-execution/
Apache License 2.0
18 stars 6 forks source link

Expose relevant interfaces from root exports; update docs #233

Closed mgramigna closed 1 year ago

mgramigna commented 1 year ago

Summary

Can now export any interface directly from fqm-execution. Updated docs, and deprecated the previous type exports to be removed as a breaking change in 2.0.

Before:

// These contain every interface/type exported in the corresponding files
import { CalculatorTypes, Enums, CQLTypes, ELMTypes } from 'fqm-execution';

After:

// Only import specific types that you are using/need to use
import { CalculationOptions, PopulationType, MeasureScoreType, FinalResult, Relevance, /* ... */ } from 'fqm-execution';

New behavior

None in runtime. Any previously export interface can now be imported directly from fqm-execution in a TypeScript project

Code changes

Testing guidance

npm link the project somewhere and try the new import style for the interfaces. Make sure the old style still works too.

github-actions[bot] commented 1 year ago

Coverage report

St.:grey_question:
Category Percentage Covered / Total
🟒 Statements
85.85% (+0.02% πŸ”Ό)
2051/2389
🟑 Branches 74.45% 1830/2458
🟒 Functions 88.05% 361/410
🟒 Lines
86.16% (+0.02% πŸ”Ό)
1980/2298

Test suite run success

383 tests passing in 29 suites.

Report generated by πŸ§ͺjest coverage report action from 29bc3d7b2f0f323e91b007744954aa938b4aa01d