UNPKG

@19labs/gale-wellness

Version:

## Overview Welcome to the [19Labs](https://19labs.com) Custom Wellness Portal SDK .

377 lines 23 kB
<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>@19labs/gale-wellness</title> <meta name="description" content="Documentation for @19labs/gale-wellness"> <meta name="viewport" content="width=device-width, initial-scale=1"> <link rel="stylesheet" href="assets/css/main.css"> <script async src="assets/js/search.js" id="search-script"></script> </head> <body> <header> <div class="tsd-page-toolbar"> <div class="container"> <div class="table-wrap"> <div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base="."> <div class="field"> <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label> <input id="tsd-search-field" type="text" /> </div> <ul class="results"> <li class="state loading">Preparing search index...</li> <li class="state failure">The search index is not available</li> </ul> <a href="index.html" class="title">@19labs/gale-wellness</a> </div> <div class="table-cell" id="tsd-widgets"> <div id="tsd-filter"> <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a> <div class="tsd-filter-group"> <div class="tsd-select" id="tsd-filter-visibility"> <span class="tsd-select-label">All</span> <ul class="tsd-select-list"> <li data-value="public">Public</li> <li data-value="protected">Public/Protected</li> <li data-value="private" class="selected">All</li> </ul> </div> <input type="checkbox" id="tsd-filter-inherited" checked /> <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label> <input type="checkbox" id="tsd-filter-externals" checked /> <label class="tsd-widget" for="tsd-filter-externals">Externals</label> </div> </div> <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a> </div> </div> </div> </div> <div class="tsd-page-title"> <div class="container"> <h1>@19labs/gale-wellness</h1> </div> </div> </header> <div class="container container-main"> <div class="row"> <div class="col-8 col-content"> <section class="tsd-panel-group tsd-index-group"> <h2>Index</h2> <section class="tsd-panel tsd-index-panel"> <div class="tsd-index-content"> <section class="tsd-index-section "> <h3>Classes</h3> <ul class="tsd-index-list"> <li class="tsd-kind-class"><a href="classes/galeapibridge.html" class="tsd-kind-icon">GaleAPIBridge</a></li> <li class="tsd-kind-class tsd-has-type-parameter"><a href="classes/galeevent.html" class="tsd-kind-icon">Gale<wbr>Event</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Interfaces</h3> <ul class="tsd-index-list"> <li class="tsd-kind-interface"><a href="interfaces/bloodpressuremeasurement.html" class="tsd-kind-icon">Blood<wbr>Pressure<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/bloodpressuremeasurementdata.html" class="tsd-kind-icon">Blood<wbr>Pressure<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/camerameasurementdata.html" class="tsd-kind-icon">Camera<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/clinic.html" class="tsd-kind-icon">Clinic</a></li> <li class="tsd-kind-interface"><a href="interfaces/documentdata.html" class="tsd-kind-icon">Document<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/galeeventtypes.html" class="tsd-kind-icon">Gale<wbr>Event<wbr>Types</a></li> <li class="tsd-kind-interface"><a href="interfaces/genericmeasurement.html" class="tsd-kind-icon">Generic<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/glucometerdata.html" class="tsd-kind-icon">Glucometer<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/glucometermeasurement.html" class="tsd-kind-icon">Glucometer<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/healthhistorydata.html" class="tsd-kind-icon">Health<wbr>History<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/imagefiledata.html" class="tsd-kind-icon">Image<wbr>File<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/intakedata.html" class="tsd-kind-icon">Intake<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/location.html" class="tsd-kind-icon">Location</a></li> <li class="tsd-kind-interface"><a href="interfaces/logininfo.html" class="tsd-kind-icon">Login<wbr>Info</a></li> <li class="tsd-kind-interface"><a href="interfaces/measurementdata.html" class="tsd-kind-icon">Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/measurementdatawithtimestamp.html" class="tsd-kind-icon">Measurement<wbr>Data<wbr>With<wbr>Timestamp</a></li> <li class="tsd-kind-interface"><a href="interfaces/measurementfiledatasummary.html" class="tsd-kind-icon">Measurement<wbr>File<wbr>Data<wbr>Summary</a></li> <li class="tsd-kind-interface"><a href="interfaces/measurementwithoptionaltimestamp.html" class="tsd-kind-icon">Measurement<wbr>With<wbr>Optional<wbr>Timestamp</a></li> <li class="tsd-kind-interface"><a href="interfaces/multifunctionmeasurement.html" class="tsd-kind-icon">Multifunction<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/otoscopeimagedata.html" class="tsd-kind-icon">Otoscope<wbr>Image<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/participant.html" class="tsd-kind-icon">Participant</a></li> <li class="tsd-kind-interface"><a href="interfaces/participants.html" class="tsd-kind-icon">Participants</a></li> <li class="tsd-kind-interface"><a href="interfaces/patientprofile.html" class="tsd-kind-icon">Patient<wbr>Profile</a></li> <li class="tsd-kind-interface"><a href="interfaces/pdfdatasummary.html" class="tsd-kind-icon">Pdf<wbr>Data<wbr>Summary</a></li> <li class="tsd-kind-interface"><a href="interfaces/pdffiledata.html" class="tsd-kind-icon">Pdf<wbr>File<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/prescriptiontext.html" class="tsd-kind-icon">Prescription<wbr>Text</a></li> <li class="tsd-kind-interface"><a href="interfaces/prescriptiontextdata.html" class="tsd-kind-icon">Prescription<wbr>Text<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/pulseoxmeasurement.html" class="tsd-kind-icon">Pulse<wbr>OxMeasurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/pulseoximeterdata.html" class="tsd-kind-icon">Pulse<wbr>Oximeter<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/sensor.html" class="tsd-kind-icon">Sensor</a></li> <li class="tsd-kind-interface"><a href="interfaces/sensortypes.html" class="tsd-kind-icon">Sensor<wbr>Types</a></li> <li class="tsd-kind-interface"><a href="interfaces/signupinfo.html" class="tsd-kind-icon">Sign<wbr>UpInfo</a></li> <li class="tsd-kind-interface"><a href="interfaces/singlemeasurementdata.html" class="tsd-kind-icon">Single<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/spirometermeasurement.html" class="tsd-kind-icon">Spirometer<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/stethoscopefiledata.html" class="tsd-kind-icon">Stethoscope<wbr>File<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/stethoscopemeasurementdata.html" class="tsd-kind-icon">Stethoscope<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/thermometermeasurement.html" class="tsd-kind-icon">Thermometer<wbr>Measurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/thermometermeasurementdata.html" class="tsd-kind-icon">Thermometer<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/updateuserinfo.html" class="tsd-kind-icon">Update<wbr>User<wbr>Info</a></li> <li class="tsd-kind-interface"><a href="interfaces/user.html" class="tsd-kind-icon">User</a></li> <li class="tsd-kind-interface"><a href="interfaces/weightscaledata.html" class="tsd-kind-icon">Weight<wbr>Scale<wbr>Data</a></li> <li class="tsd-kind-interface"><a href="interfaces/weightscalemeaurement.html" class="tsd-kind-icon">Weight<wbr>Scale<wbr>Meaurement</a></li> <li class="tsd-kind-interface"><a href="interfaces/zoomcallurl.html" class="tsd-kind-icon">Zoom<wbr>Call<wbr>Url</a></li> </ul> </section> <section class="tsd-index-section "> <h3>Type aliases</h3> <ul class="tsd-index-list"> <li class="tsd-kind-type-alias"><a href="modules.html#builtinsensortypes" class="tsd-kind-icon">Builtin<wbr>Sensor<wbr>Types</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#eventtype" class="tsd-kind-icon">Event<wbr>Type</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#screenname" class="tsd-kind-icon">Screen<wbr>Name</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#sensormeasurementdata" class="tsd-kind-icon">Sensor<wbr>Measurement<wbr>Data</a></li> <li class="tsd-kind-type-alias"><a href="modules.html#sensorstate" class="tsd-kind-icon">Sensor<wbr>State</a></li> </ul> </section> </div> </section> </section> <section class="tsd-panel-group tsd-member-group "> <h2>Type aliases</h2> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="builtinsensortypes" class="tsd-anchor"></a> <h3>Builtin<wbr>Sensor<wbr>Types</h3> <div class="tsd-signature tsd-kind-icon">Builtin<wbr>Sensor<wbr>Types<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><a href="interfaces/sensortypes.html" class="tsd-signature-type" data-tsd-kind="Interface">SensorTypes</a></div> <aside class="tsd-sources"> <ul> <li>Defined in src/types.ts:309</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="eventtype" class="tsd-anchor"></a> <h3>Event<wbr>Type</h3> <div class="tsd-signature tsd-kind-icon">Event<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">keyof </span><a href="interfaces/galeeventtypes.html" class="tsd-signature-type" data-tsd-kind="Interface">GaleEventTypes</a></div> <aside class="tsd-sources"> <ul> <li>Defined in src/client/bridge.ts:63</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="screenname" class="tsd-anchor"></a> <h3>Screen<wbr>Name</h3> <div class="tsd-signature tsd-kind-icon">Screen<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;login&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;signup&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;callcenter&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;clinic&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;wellness&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sensors&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;summary&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;newSession&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;switchProfile&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;sensor&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;logout&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/types.ts:296</li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Screens that the page can navigate to using the navigate() command.</p> </div> </div> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="sensormeasurementdata" class="tsd-anchor"></a> <h3>Sensor<wbr>Measurement<wbr>Data</h3> <div class="tsd-signature tsd-kind-icon">Sensor<wbr>Measurement<wbr>Data<span class="tsd-signature-symbol">:</span> <a href="interfaces/sensortypes.html" class="tsd-signature-type" data-tsd-kind="Interface">SensorTypes</a><span class="tsd-signature-symbol">[</span><span class="tsd-signature-symbol">keyof </span><a href="interfaces/sensortypes.html" class="tsd-signature-type" data-tsd-kind="Interface">SensorTypes</a><span class="tsd-signature-symbol">]</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/types.ts:310</li> </ul> </aside> </section> <section class="tsd-panel tsd-member tsd-kind-type-alias"> <a name="sensorstate" class="tsd-anchor"></a> <h3>Sensor<wbr>State</h3> <div class="tsd-signature tsd-kind-icon">Sensor<wbr>State<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">&quot;Disconnected&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Scanning&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Connected&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Active&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Connecting&quot;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">&quot;Setup&quot;</span></div> <aside class="tsd-sources"> <ul> <li>Defined in src/types.ts:130</li> </ul> </aside> </section> </section> </div> <div class="col-4 col-menu menu-sticky-wrap menu-highlight"> <nav class="tsd-navigation primary"> <ul> <li class="current "> <a href="modules.html">Exports</a> </li> </ul> </nav> <nav class="tsd-navigation secondary menu-sticky"> <ul class="before-current"> <li class=" tsd-kind-class"> <a href="classes/galeapibridge.html" class="tsd-kind-icon">GaleAPIBridge</a> </li> <li class=" tsd-kind-class tsd-has-type-parameter"> <a href="classes/galeevent.html" class="tsd-kind-icon">Gale<wbr>Event</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/bloodpressuremeasurement.html" class="tsd-kind-icon">Blood<wbr>Pressure<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/bloodpressuremeasurementdata.html" class="tsd-kind-icon">Blood<wbr>Pressure<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/camerameasurementdata.html" class="tsd-kind-icon">Camera<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/clinic.html" class="tsd-kind-icon">Clinic</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/documentdata.html" class="tsd-kind-icon">Document<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/galeeventtypes.html" class="tsd-kind-icon">Gale<wbr>Event<wbr>Types</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/genericmeasurement.html" class="tsd-kind-icon">Generic<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/glucometerdata.html" class="tsd-kind-icon">Glucometer<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/glucometermeasurement.html" class="tsd-kind-icon">Glucometer<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/healthhistorydata.html" class="tsd-kind-icon">Health<wbr>History<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/imagefiledata.html" class="tsd-kind-icon">Image<wbr>File<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/intakedata.html" class="tsd-kind-icon">Intake<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/location.html" class="tsd-kind-icon">Location</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/logininfo.html" class="tsd-kind-icon">Login<wbr>Info</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/measurementdata.html" class="tsd-kind-icon">Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/measurementdatawithtimestamp.html" class="tsd-kind-icon">Measurement<wbr>Data<wbr>With<wbr>Timestamp</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/measurementfiledatasummary.html" class="tsd-kind-icon">Measurement<wbr>File<wbr>Data<wbr>Summary</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/measurementwithoptionaltimestamp.html" class="tsd-kind-icon">Measurement<wbr>With<wbr>Optional<wbr>Timestamp</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/multifunctionmeasurement.html" class="tsd-kind-icon">Multifunction<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/otoscopeimagedata.html" class="tsd-kind-icon">Otoscope<wbr>Image<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/participant.html" class="tsd-kind-icon">Participant</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/participants.html" class="tsd-kind-icon">Participants</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/patientprofile.html" class="tsd-kind-icon">Patient<wbr>Profile</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/pdfdatasummary.html" class="tsd-kind-icon">Pdf<wbr>Data<wbr>Summary</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/pdffiledata.html" class="tsd-kind-icon">Pdf<wbr>File<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/prescriptiontext.html" class="tsd-kind-icon">Prescription<wbr>Text</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/prescriptiontextdata.html" class="tsd-kind-icon">Prescription<wbr>Text<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/pulseoxmeasurement.html" class="tsd-kind-icon">Pulse<wbr>OxMeasurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/pulseoximeterdata.html" class="tsd-kind-icon">Pulse<wbr>Oximeter<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/sensor.html" class="tsd-kind-icon">Sensor</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/sensortypes.html" class="tsd-kind-icon">Sensor<wbr>Types</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/signupinfo.html" class="tsd-kind-icon">Sign<wbr>UpInfo</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/singlemeasurementdata.html" class="tsd-kind-icon">Single<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/spirometermeasurement.html" class="tsd-kind-icon">Spirometer<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/stethoscopefiledata.html" class="tsd-kind-icon">Stethoscope<wbr>File<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/stethoscopemeasurementdata.html" class="tsd-kind-icon">Stethoscope<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/thermometermeasurement.html" class="tsd-kind-icon">Thermometer<wbr>Measurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/thermometermeasurementdata.html" class="tsd-kind-icon">Thermometer<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/updateuserinfo.html" class="tsd-kind-icon">Update<wbr>User<wbr>Info</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/user.html" class="tsd-kind-icon">User</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/weightscaledata.html" class="tsd-kind-icon">Weight<wbr>Scale<wbr>Data</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/weightscalemeaurement.html" class="tsd-kind-icon">Weight<wbr>Scale<wbr>Meaurement</a> </li> <li class=" tsd-kind-interface"> <a href="interfaces/zoomcallurl.html" class="tsd-kind-icon">Zoom<wbr>Call<wbr>Url</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#builtinsensortypes" class="tsd-kind-icon">Builtin<wbr>Sensor<wbr>Types</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#eventtype" class="tsd-kind-icon">Event<wbr>Type</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#screenname" class="tsd-kind-icon">Screen<wbr>Name</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#sensormeasurementdata" class="tsd-kind-icon">Sensor<wbr>Measurement<wbr>Data</a> </li> <li class=" tsd-kind-type-alias"> <a href="modules.html#sensorstate" class="tsd-kind-icon">Sensor<wbr>State</a> </li> </ul> </nav> </div> </div> </div> <footer class="with-border-bottom"> <div class="container"> <h2>Legend</h2> <div class="tsd-legend-group"> <ul class="tsd-legend"> <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li> <li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li> <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li> </ul> <ul class="tsd-legend"> <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li> </ul> </div> </div> </footer> <div class="container tsd-generator"> <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p> </div> <div class="overlay"></div> <script src="assets/js/main.js"></script> </body> </html>