diff --git a/assets/navigation.js b/assets/navigation.js index a20b455..ce01c23 100644 --- a/assets/navigation.js +++ b/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WUUU+DMBSF/0ufiZNlm7o3onswWZZpND4se+jgDhpLS8plkZj9d8N0roXSEn2kPffj9tzTbj4JwgeSOVmDKqUgASkoZmROcplUHMrR9/pVhjknAXlnIiHzSUDijPFEgSDzzS/iEPaWH8JBhHYTTCCoPY0NkK2j8XR2DFqYN4bZkgmgKQwianoXPAW84PaViJFJodNSQLN+NjHLI869hIhzN2RtHKuHsu6cpY2xmtRD6zVoNjluj1t9AJzGYAlDs/z3KJ2qhybJ7EAf+xlj6aYVo0bgTZGB+2eGzixvhHxj00DDp/ZUUc72DFTX+9+tQebfS4E0xpe6AAsT68Ig2tQt867vbsLpWGv1tWLJALQh8zF3tdaJzdULyZA6JrWrmw58rEbjgLDS7acNaq9x/qTHUjvdYewpVhfwozhQzpJIpVUOAhdKSY0ec1qWUI5sKhMbjm816gNF2pyw+bLdSm3fdQ9XUizyAutIKVq3Y2Rs+sKzqjinOw4dyM+6rz4FbHouZaVia/gMgftxWMqYcqtDBq4tc0OfIZcIfmpH103HFzgRiMd1CAAA" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WSX0+DMBTFv0uficqyYeTNqG/LoibGh2UPHVygsbSkXBaJ4bsbNjfaUv7EPbY995fTc+72hyB8IwnJK6hSCuKRgmJGQpLLuOJQ3p7ubzLMOfHIFxMxCZceiTLGYwWChNsL4uAPjh/8WQTbBBMIKqGRAXI5WqyCxrMwnwyzNRNAU5hF1PRj8BSwwyWViJBJodNSQHM+WJrjTmMDpEFTwbLZNTv905xG4Cigvf5/fcfpue2ZDvSozxiHG6u6VjDZnIG7srcz6+raNND81t4qylnCQPWzvzzNCv+jYrEDhnVhoAyZFdfdw72/Wmjm9nUrd322Q5w0I8mxcsCai2aJHeF14GeK9EmK48m1Jdr72F5spHjJC6wflaK1HZzxOBXXpuKc7jn0IH/3U/MpYOu5lJWKnCtmCMaXdS0jyp0JGThbNg59h1wiTFN7un6Pv4DXMPV5BgAA" \ No newline at end of file diff --git a/assets/search.js b/assets/search.js index 4250261..5ec9b67 100644 --- a/assets/search.js +++ b/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA92cS2/jOBKA/4tydTvhm8wtMzuHAQaL7GJ352AEgWKrE2EdO2vLmQ6C/u8LypTFUpE2Fcnd6D45kVkv1sfiw5Les836r212PXvP/luuFtm15JNslT8X2XX2WFR/y6t8u95t5kU2yXabZXadfd6t5lW5Xm0vwffTp+p5mU2y+TLfbottdp1lXycHpUIwedB7f1+9vaQpvICXDpKelUn2km+KVdV1eArdb50hV7SN8ZV83I9pLdzblSaKc3XP9JW4vz4N8c9GF+m0p3x7W2yey+3W+jWOp1OkdIDj37KLO4431/koEXR7JZ6Qm9Vb23C8yLpqf6CkANebb+hoaYE9E0nMyzJPLJ2nQ2p0/SgpqP09/CvG6fh9J0R6+7Gofnn7965cnCeC6UH/0MIKovmeSfFDOlyV4wfX2jmZuz/L6umPclXkj2eP2TP1E2YURHdooM+ZXD93sYpYbLajTVAHZT9MTawdbv4fa6Dte+FbFUUYwtTXP1ow3zMpbUTNJXOG0L5vRYxFDE39ZOn0gju0Hqvsh1ObUA8fi+o2fyx+efvXWXsA2Php8tpGdWjGzpRQrwOPjdfzZvHnyyDMnjrbaOwkjl4ZRQQ9hPn33XKZPyzbQK3k9rK5fPRwC+lar357fqnebjab/K2r0P/uuFbRJsHG+ut6VRVfqoO+clUVm8/5vNheel8fVQlofbCXEpRduIbhtPieJSJ0ytapQz5fqPbNswsG4x/reb4MdR2AuNvq+DkmMPDP4nldFSctoGbHk0T1wcbvq9d8WS5uNo+752JV/bbZrDcHG076MtToqAVBWlbn69W22uzmVR/FF1AqnKag760TbUfewg3B83qxWxbby/3lo4EET3E78q8koMJz87a7dvbHXcc1j9xWe9RPZOTIgeoir4r79ef7h3JTPSXbu+iKnbA+RcHCndnTehUcpmHjTfOBRvOqLFbVfRksRhHLvsww89viS7rdfeNhBufrVZXPq2hJDFvuSLUuVNvFp3L7qVw9FZuyKhYfcan+SHbFtR7XhU3xst5UxeLeEp3uS1dsXKf6pegsqbnfFK/pLrjWI7vQZ2R2h+QYDjiBHtXBtR/sBp4KQjvxIw75G85hE0R6J3RthvrjWPwJW9besxXyKT5x9UlVymlj6pyGuw1Nb2O71mvmC6Q1OAmO7GTi/Ii8606VI7vVdxZF/o0yoSY4mjq3IgcHTbMJjvWecZGH40y+Ca5+OMnnTm7q7IwcGzRRpzj2wZoyfjGBG+bA/rhV81iENsYnJsnEwypsxR5WnTppgFLW/1hgx0/ogZ5Ba4KPhIuy3LnWpxN8uU7Ysa65TeiT22/WGbd+L9z2Df/WxX17LOCb5fKUFzfL5bcJtzF04f7uE6xt78IJHtuAO1sOpy71z8IfP7SpxU+e2XTuAQHrdOCWX/wa1TEXuwaOrMbd6iHRzEXb/Li5aTcwfCtRrLIHrHrth5g9udSKB9xzdZXkTnRBFXCj3xoqyfzpZVPAjw+ulJIc6pOWM6QjugQKmO+36kkznz4ceq1t0gZkfE8eGo49jyViLqBid+pMAihKX32MVQJjW6/EspS0kU7LQ++Tkd6OJFdo7EqoWKfzMcaWOSlrQ0r6kO3ycecGFPpRtsrHvRuj/A/ZJh/37rwJTZsfBm6Qezv1oSE69ug8vTVulJzeGeNinbpb6NpI2hf7QgO2xZ6aIfPSB0IduieOqIpuidte+ccuX5afy2KD9j6Hb3rdbGLvMsM69zebtBpBq+Md3CoLZvUhditpq37fZJCVchuOK2Su07a/3W6X/rqf6uwdQ6d7NtR4YAd7Kk/0s9dyYHcfjTnc64Miv5tk5WpRfMmu37PXYlM/QnOd0Smb2nttP5fFcmEfSmwWBPP18/N+qbZYz+v7SbI71+w/hb0NxTbet768yiazqwmn0yuj7u4ms0a4/qK+0Ohor9SCJJvMyITIKedQkCBBAgRpNpnRCWNTSTkQpEiQAkEWs8iQIAOCPJvMWChGjgQ5EBQxiwIJCiAos8mMhyxKJCiBoIpZVEhQAUGdTWYi1KsaCWogaGIWDRI0EADLg5wwOTVaQwIwO6QDT5yeAD6QH2KpUEG7mCACESJRhgiGiECKiGVDh7qYYI4IBIlESSIYJQJZsg8YRfoZ00QgTiTKE8FAEUiUffYl0s+YKQKhIlGqCMaKQK6oRcWEBg/FXFHIFY1yRTFXtFOXLCokWAtpoDRBsGgULIrBohAsalkhJGgYk0UhWbQmiwaFMVoUokUtLSRYGilmi0K2aM1WsMpRDBeFcFEd7S8MF4Vw0RouETSM6aKQLmaBITIkzDBeDOLFarxUUBjzxSBfrOZLB4UxX6wz97FY8WGB2Q/yxXhsxmUYLwbxYiJqF9PFIF2spsuEKgjDdDFIF7O80KugMKaLQbqYBYaSoDDGi0G8mAWG0qAwxotBvLgFhrIJI1NC4FoD08UhXdzyQnlIFsPFIVy8XlWJkCxmi0O2uMWFypAsZot3llY1WyokG1hcQba4xYXqkCxmi0O2uKWFmpAsRotDtLiFhQULPcdocYgW11HDmCwOyeImOiA4JotDssRVdEAIjJaAaAkSHRACsyUgW4JGB4TAcAkIl2CxASEwXALCJXhsQAgMl+gs3UVsQIjA4h3CJWRsQAgMl4BwCRUbEAKzJSBbQscGhMBsCciWsLSwcIYxWwKyJa9is7HEaEmIlrSwsCAdEqMlIVqSRg1jsiQkS1pYWHDxIjFaEqIledQwRktCtKSlhYW3d5gt2dkZyqjhwN4QsiVVbJMnMVsSsiV1bBEgMVsSsiVN1C5GS0K0lKWFiRAeCrOlIFuqZiu491GYLQXZUjRWeRRmS0G2FItVHoXRUhAtxWOVR2G0FERLiVjlUZgsBclSMlZ5FCZLdY4dVKzyqMDBAyRLRWdEhclSkCxVV63gglphtBRES8fR0hgtDdHSJOa1xmRpSJamUSw1RktDtHR0QtQYLQ3R0tEJUWO0NERLRydEjdHSEC0dnRA1RktDtHR0QtQYLd051IpOiDpwrAXR0vEJUWO0NETLRCdEg8kykCwTnxANRstAtEx0QjSYLAPJMvWEGNxgGoyWgWiZ+pA0eOxiMFsGsmUsLjy4ojYYLgPhMvVhafD4w2C6DKTLWGB48PjDYLwMxMtYYnhwBWEwX6ZzbmqJ4cFVgAkcne4v1Qf5r4X9ffv3/YH+bHb4De49u3en/KT5reE9I9n1+9dJxvYfYv+h9h9m/0FcG+IaEdeKuGbEtaOuHXXtqN5/yiv3Sd0nd5/SmXHfm/r7r+3vC/XVw08M9jsbc/3LbxtL+4Due8adZ8JZVs5DrdM0179ze6qVp9o5LZxK5ZzXKkn1/rFtLwO8VU0TVby5uz662eSs1WXSIn142+1gN/IrT4lIUgKeO/ZC8xLC0lJ6uAmp1cJEq0U5QPRVH22Ieur1E3cqhWNVOTY162PCWvhf+wOd15vU68209C7yKp83D657vek5TWWqJv9xLk+X8TLj+OUmSWd9T4SXHa+CCDf8dbKm3N6T7SnzxoJMQ++xqB7eUFXzEKZp4NV6ukNBetXRYULSev6g7q+yelo2t1q0mr16QhxwJG3APhbVwnv5a6vSizltdDwW1dK+ZCHGmzfuaHJGXzqBMo9amTaknBacVg9amhzipn7LQyxGL8MsWWUkp8wb6tLNgIYkKX3Kt/nq7cV7oadXQTytqcpe/Be2eh56ZS9JVbl/WUTuXhZR7F904fWfxzFLC7XcniyZXsQmDbxya8daWJtXoExaB9bN/enCc4i7xAq3ClBu2tBpHbparwr7npl8/w4aryc9eGha6Vsd3o3jqfGipWkuNXfbevF6A403s0OzkHKfOi3b/tOwngHPS+YUikSF7tUfrTJvkUFcUphLCkvryL3O2Kj26ipPm8DdI8pevJ4O5paNIq3cuJfLtrq8qtysqp1GmTZW2luavSC9Oqgc4Tpt4qzVxfrOKw8qzbvgGGZejk3aJNK5udfLhdeB3E29otntOH50Gjf1w9SeZm8IM7cUEmmdiBaoXj54syNzI1E5Z3VaMYsWRuaNcpNWKuyTYZ6TXqlx463ZzyUsZe4m2Uv5UlhqsuvZ3dev/wcZuJU38l4AAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA92cS2/jyBGA/wvnypHVb8q3zeMQYBFMAiQ5CIbBkWibiCw5Iu0dw5j/HjTZFLtYXVLTpHcwe5JNdb26vupi86G35Hj4rUqu12/Jf8v9NrnWMk32+WORXCf3Rf2XvM6rw/NxUyRp8nzcJdfJ3fN+U5eHfXUFvl881I+7JE02u7yqiiq5TpLv6UmpUkKf9N7e1q9PcQo/wUMnSc9Kmjzlx2JfDx1eQPd7Z9iS9zG+sPf7sWiER7vSRfFR07N4Ye6vz1P8s9ERk/aQV1+K42NZVdaveTxdIKUTHP89p3jgeHdczhLBcFbohPyyf+0HzhfZUO1PlBTgevcNny0tcGaIxDzt8sil83JIna6fJQWNv6d/Jy5F3V/tJBCzfV/Uf3r913O5/ZgIFif9UxdWEM2PTIof0unoTDXim+rtXMzdf8r64ddyX+T3Hx6zZ+oPmFEQ3WnATH0pnFw/d9SKWByr2RrUSdlPsyY2Dnf/65ly0c7C77UowhAWvv7ZgvmRSekj6g6ZDwjtx66IVMTQ1B8snV5w3berD81seDnky5Vhip+C//vzbpd/3fXhWyXVVXf47MYa6Trs//r4VL/+cjzmr0OF/nfntao+NTbsPx/2dfGtPukr93VxvMs3RXXlfX1WJSD7qz0UoeyTGxjOkO9ZJFiXbF26wOALNb55dkHh/nrY5LvQ1AG0h6POX0MBBv5ZPB7q4qIFNOysid7CF9ilHw/b511RXbWHI3V4l1YG8i8soMKb5i/DhuYDOXDNS2mvnfQTGTlzlWOb18Xt4e72a3msH6LtfRqKXbC+QMHC06WHwz7Ib9h4N3yi0bwui319WwarlLDsy0wzXxXf4u22g6cZ3Bz2db6pybUibHkg1btQV9vPZfW53D8Ux7Iutu9xqfmIdsWNnteFY/F0ONbF9tYSHe/LUGxep8al6ENSc3ssXuJdcKNndmFMZQ5Lcg4HnMCI1cGNn+wGbgWh0+MzDvlngdMaRPwkDG2G5uNc/BH76tHdCvlEN64xqYq5BBDb0/C0ofY2t2ujOl8grcEmOLOTkf0ReTdslTO7NbaLIv9maagRjsb2VuTgpDYb4djojos8nKf5Rrj67iR/dHJjuzNybFKjjnHsnWvK/IsJ3EkGNo69mvsitGO80CQjr+1gK/bazqUtOJSy/lOBnb9sBvRMOid4T7goy4NjYybBlxuEHdzag1uSp515cz3//Rv7Rvzivn5w8w6cywG3/ALpVFMuDg2cOWNzHSbSzKd++Hlzi2Fg+B4wVf0Bq974KWYvtmM64JEdOModsukG3BjXZ6PMX26tAT/e2U2jHBqTlg9IB9kmA+bHdcY48/HlMKr/xRUkvW8LlePIrSvlAlrsLu1bgaL4DjXXEkidnkcuS1Gbrbg8jN49j3YkeoXGroQW63g+5thWRWVtypI+ZUt13rkJC/0s26nz3s2x/E/ZSp337mMTGtcfJm6iRjv1rhKduzovb586JZd3T3ixjt1NDG1E7Z18oQlbJ0/NlL70jlCn7psIVRHbpn8857vyriyOaO9z+mbUnXr7fADW2d6p7zWCUecnuFcWzOpX6hmgXn07ZJKVsgrHFTI3GBtt9yZNyv22+JZcvyUvxbF5/PY64QuxsE9z3JXFbmtfaOh60ubw+NieLWwPm+fmzxs37N/Fpj4c7eB29NUySdfLVC4Xhq1ubtJ1J9x80RzodPRHGkGWpGuWMrMQWgFBhgQZEORJuuap4AsuNRDkSJADQUFZFEhQAEGZpGsRilEiQQkEFWVRIUEFBHWSrmXIokaCGggayqJBggYIZkm6VqFZzZBgBgRXlMUVElxBACwPOhVqoRkEAKPDBuzQ8ATogfjYZ3XXJmQW88MgQIwkiGGEGGTIPkW6zkITzDBFDGLESI4YBolBkpimZhmjxCBLjISJYZoYxIll1CxjnhgEipFEMYwUg0xxy8kqVDgcQ8UhVLyBKriWcUwVHyxKlhTGgsKBdQlyxRuueFAYg8UhWFxS08UxWByCxRuwgksbx2RxSBa3tLDgKsUxWxyyxQ1VDhyzxSFbPCM7AIaLQ7j4irSL4eIQLmF5YSoAtcBwCQiXaOAK1aHAbAnIlmjYChWTwGiJQc9r0MpCsoGuB8kSDVmrlK8WRggojNESEC1hYeHLoDBGS0C0hIWFs6AwRktAtISlhfOgMGZLQLZEw5YICmO4BIRLWF64DApjugSkS1pguAoJS4yXhHhJSwzXwXMUzJeEfElOW8aASQiYFFRRSAyYHJxXSaooZODMCvIlFVUUEuMlIV5SU0UhMV0S0iUNWRQS0yUhXTIji0JiuiSkS67IopCYLgnpUkuyKBSmS0G6FCOLQmG6FKRLcbIoFKZLQbqUBYaHsqwwXQrSpcjGqDBdanDi3qxeIUJU4NQd0qU0aRfTpSBdylCn4QrDpSBcimyLCrOlIFtqRdrFaCmIlm7QWgXmSmOyNCRLW1bEMiSLwdIQLM3JStQYLA3B0oKsRI3J0pAsLclK1BgtDdHSiqxEjdnSg32hJitRB7aGEC5tyErUmC4N6dIZ2SQ0xktDvLQlRgTPjjXmS0O+DMmXwXwZyJdhpNcGA2YgYIZTcBrMl4F8GUHCaTBfBvJlJAmnwXwZyJdRJJwG82UgX0aTcBrMlxlcezAknCZw+QHyZTISToP5MpAvs6LahMF4GYhXtqSW6wzjlUG8Mka1iQzTlUG6Mk7axXRlkK7M8iKCG8YM05VBurLmclZw05dhujJIV2Z5EcFNX4bpyiBdmeVFqKAwpssdaq5dvhT2rtLf2muY6/XpyvdbcusubLLugupbwpLrt+9pItoP1X6Y9mPVfjA3hrlBzI1ibhhz47h0SrpP3X5mS/fJ7ef3/pJpc/R01dR+Z2Nq7qf0vvb3Z94S4Swp3n5q54HJ4jQ3d4881cJTnTnVLljtnDcmSnX7Jpk3w7xXzUWcitfnZxi68ELPVJSS0010L8pVr0W7VJjlGG2YH0+lcNmWLhfa5cbERb3N63zTvWLmWfAQ5XHcDJ4v93Qpz1s3ATLOu+YGnDeVptekXDWYVawmnGDt1aFzjOlx6n4r64dddyut1+w5ylxCWFyR3Bf11vtVpl7lslcZR899Ue/sG4hUir3q43F03xf1sXnjkFLpFQyPnkhiCnnmJdsteRmLUvqQV/n+9cn7YZteredinIcPefXk/3CRtz70qmSUqrKyyPyvv33m6fKKJItzrL0B5k2YR4hwEybdsqq7aolzdH/YF/Zd4rx9z9jLsGeDxyVjf3r/uVfjrV88DubumSAvXG/GZLesdI3JhW3iXPTf6/Bi9YpYOMUyrlC6H67olXkwM7dic7di87gVrNVJFYu3lMnIoNuXbbx4PR3CtWEZx4v77aJel0+za+wuWhUZ7enBK69GPPi0c9DENadGHTF3wut1Os67cAl75xxZXH8bPILk5dPzSbhTIenOvrTjx8Sx2LwW5GXZI1G4VUHGLTjD0xDuBSy69LpK1N2pbJxqel30FtksDkb7/LrnpLfUuHrriIxoyDdp8lQ+FZaa5Hp98/37/wGqocceUVEAAA=="; \ No newline at end of file diff --git a/classes/InvalidArgumentError.html b/classes/InvalidArgumentError.html deleted file mode 100644 index 41e020f..0000000 --- a/classes/InvalidArgumentError.html +++ /dev/null @@ -1,17 +0,0 @@ -InvalidArgumentError | @medic/cht-datasource

Class InvalidArgumentError

Represents an error that occurs when an invalid argument is provided. -This error is typically thrown when a function or method receives an argument -that doesn't meet the expected criteria or constraints.

-

Hierarchy

  • Error
    • InvalidArgumentError

Constructors

constructor -

Properties

cause? -message -name -stack? -prepareStackTrace? -stackTraceLimit -

Methods

captureStackTrace -

Constructors

constructor

Properties

Optionalcause

cause?: unknown

message

message: string

name

name: string

Optionalstack

stack?: string

Static OptionalprepareStackTrace

prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

-

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

-

StaticstackTraceLimit

stackTraceLimit: number

Methods

StaticcaptureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    -

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/functions/Person.v1.get.html b/functions/Person.v1.get.html index d7bc69d..6ffa278 100644 --- a/functions/Person.v1.get.html +++ b/functions/Person.v1.get.html @@ -2,4 +2,4 @@

Throws

Error if the provided context or qualifier is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Person.v1.getAll.html b/functions/Person.v1.getAll.html deleted file mode 100644 index 58c3cb0..0000000 --- a/functions/Person.v1.getAll.html +++ /dev/null @@ -1,9 +0,0 @@ -getAll | @medic/cht-datasource

Function getAll

Returns a function for getting a generator that fetches people from the given data context.

-

Throws

Error if a data context is not provided

-
  • getAll(context): ((personType: Readonly<{
        contactType: string;
    }>) => AsyncGenerator<Person, null, unknown>)

  • Parameters

    Returns ((personType: Readonly<{
        contactType: string;
    }>) => AsyncGenerator<Person, null, unknown>)

    a function for getting a generator that fetches people

    -
      • (personType): AsyncGenerator<Person, null, unknown>

      • Returns a generator for fetching all people with the given type

        -

        Parameters

        • personType: Readonly<{
              contactType: string;
          }>

          the type of people to return

          -

        Returns AsyncGenerator<Person, null, unknown>

        a generator for fetching all people with the given type

        -

        Throws

        Error if no type is provided or if the type is not for a person

        -

Settings

Member Visibility
diff --git a/functions/Person.v1.getPage.html b/functions/Person.v1.getPage.html deleted file mode 100644 index 33840e6..0000000 --- a/functions/Person.v1.getPage.html +++ /dev/null @@ -1,15 +0,0 @@ -getPage | @medic/cht-datasource

Function getPage

Returns a function for retrieving a paged array of people from the given data context.

-

Throws

Error if a data context is not provided

-

See

getAll which provides the same data, but without having to manually account for paging

-
  • getPage(context): ((personType: Readonly<{
        contactType: string;
    }>, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>)

  • Parameters

    Returns ((personType: Readonly<{
        contactType: string;
    }>, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>)

    a function for retrieving a paged array of people

    -
      • (personType, cursor?, limit?): Promise<Page<Person>>

      • Returns an array of people for the provided page specifications.

        -

        Parameters

        • personType: Readonly<{
              contactType: string;
          }>

          the type of people to return

          -
        • cursor: Nullable<string> = null

          the token identifying which page to retrieve. A null value indicates the first page should be -returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.

          -
        • limit: number = 100

          the maximum number of people to return. Default is 100.

          -

        Returns Promise<Page<Person>>

        a page of people for the provided specification

        -

        Throws

        Error if no type is provided or if the type is not for a person

        -

        Throws

        Error if the provided limit value is <=0

        -

        Throws

        Error if the provided cursor is not a valid page token or null

        -

Settings

Member Visibility
diff --git a/functions/Person.v1.getWithLineage.html b/functions/Person.v1.getWithLineage.html index f4ba617..1f265bb 100644 --- a/functions/Person.v1.getWithLineage.html +++ b/functions/Person.v1.getWithLineage.html @@ -2,4 +2,4 @@

Throws

Error if the provided context or qualifier is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Place.v1.get.html b/functions/Place.v1.get.html index e0d3e96..fea5f31 100644 --- a/functions/Place.v1.get.html +++ b/functions/Place.v1.get.html @@ -2,4 +2,4 @@

Throws

Error if the provided context or qualifier is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Place.v1.getWithLineage.html b/functions/Place.v1.getWithLineage.html index 5c37f0d..026197a 100644 --- a/functions/Place.v1.getWithLineage.html +++ b/functions/Place.v1.getWithLineage.html @@ -2,4 +2,4 @@

Throws

Error if the provided context or qualifier is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Qualifier.byContactType.html b/functions/Qualifier.byContactType.html deleted file mode 100644 index 84de15d..0000000 --- a/functions/Qualifier.byContactType.html +++ /dev/null @@ -1,5 +0,0 @@ -byContactType | @medic/cht-datasource

Function byContactType

Build the TypeQualifier that categorizes an entity by its type

-

Throws

Error if the type is invalid

-
  • byContactType(contactType): Readonly<{
        contactType: string;
    }>

  • Parameters

    • contactType: string

      the type of the entity

      -

    Returns Readonly<{
        contactType: string;
    }>

    the type

    -

Settings

Member Visibility
diff --git a/functions/Qualifier.byUuid.html b/functions/Qualifier.byUuid.html index e868e47..a2f59c8 100644 --- a/functions/Qualifier.byUuid.html +++ b/functions/Qualifier.byUuid.html @@ -2,4 +2,4 @@

Throws

Error if the UUID is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Qualifier.isContactTypeQualifier.html b/functions/Qualifier.isContactTypeQualifier.html deleted file mode 100644 index 992ec73..0000000 --- a/functions/Qualifier.isContactTypeQualifier.html +++ /dev/null @@ -1,4 +0,0 @@ -isContactTypeQualifier | @medic/cht-datasource

Function isContactTypeQualifier

Returns true if the given qualifier is a ContactTypeQualifier otherwise false.

-
  • isContactTypeQualifier(contactType): contactType is Readonly<{
        contactType: string;
    }>

  • Parameters

    • contactType: unknown

      the type to check

      -

    Returns contactType is Readonly<{
        contactType: string;
    }>

    true if the given type is a ContactTypeQualifier, otherwise false.

    -

Settings

Member Visibility
diff --git a/functions/Qualifier.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index c63f3f5..be97287 100644 --- a/functions/Qualifier.isUuidQualifier.html +++ b/functions/Qualifier.isUuidQualifier.html @@ -2,4 +2,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getDatasource.html b/functions/getDatasource.html index 4bd7918..3ae7691 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -1,8 +1,8 @@ getDatasource | @medic/cht-datasource

Function getDatasource

Returns the source for CHT data.

Throws

Error if the provided context is invalid

-
  • getDatasource(ctx): {
        v1: {
            hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
            hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
            person: {
                getByType: ((personType: string) => AsyncGenerator<Person, null, unknown>);
                getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
                getPageByType: ((personType: string, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>);
            };
            place: {
                getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

  • Parameters

    Returns {
        v1: {
            hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
            hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
            person: {
                getByType: ((personType: string) => AsyncGenerator<Person, null, unknown>);
                getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
                getPageByType: ((personType: string, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>);
            };
            place: {
                getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

    the CHT datasource API

    -
    • v1: {
          hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
          hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
          person: {
              getByType: ((personType: string) => AsyncGenerator<Person, null, unknown>);
              getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
              getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
              getPageByType: ((personType: string, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>);
          };
          place: {
              getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
              getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
          };
      }
      • hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean)
          • (permissionsGroupList, userRoles, chtPermissionsSettings): boolean

          • Verify if the user's role has all the permissions of any of the provided groups.

            +
  • getDatasource(ctx): {
        v1: {
            hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
            hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
            person: {
                getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
            };
            place: {
                getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

  • Parameters

    Returns {
        v1: {
            hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
            hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
            person: {
                getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
            };
            place: {
                getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
            };
        };
    }

    the CHT datasource API

    +
    • v1: {
          hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean);
          hasPermissions: ((permissions: string | string[], userRoles: string[], chtPermissionsSettings: object) => boolean);
          person: {
              getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
              getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
          };
          place: {
              getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
              getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
          };
      }
      • hasAnyPermission: ((permissionsGroupList: string[][], userRoles: string[], chtPermissionsSettings: object) => boolean)
          • (permissionsGroupList, userRoles, chtPermissionsSettings): boolean

          • Verify if the user's role has all the permissions of any of the provided groups.

            Parameters

            • permissionsGroupList: string[][]

              {string[][]} Array of groups of permissions due to the complexity of permission grouping

            • userRoles: string[]

              {string[]} Array of user roles.

            • chtPermissionsSettings: object

              {object} Object of configured permissions in CHT-Core's settings.

              @@ -10,34 +10,20 @@

              Parameters

              • permissions: string | string[]

                {string | string[]} Permission(s) to verify

              • userRoles: string[]

                {string[]} Array of user roles.

              • chtPermissionsSettings: object

                {object} Object of configured permissions in CHT-Core's settings.

                -

              Returns boolean

        • person: {
              getByType: ((personType: string) => AsyncGenerator<Person, null, unknown>);
              getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
              getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
              getPageByType: ((personType: string, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>);
          }
          • getByType: ((personType: string) => AsyncGenerator<Person, null, unknown>)

            Returns a generator for fetching all people with the given type.

            -

            Throws

            Error if no type is provided or if the type is not for a person

            -
              • (personType): AsyncGenerator<Person, null, unknown>

              • Parameters

                • personType: string

                  the type of people to return

                  -

                Returns AsyncGenerator<Person, null, unknown>

                a generator for fetching all people with the given type

                -
          • getByUuid: ((uuid: string) => Promise<Nullable<Person>>)

            Returns a person by their UUID.

            -

            Throws

            Error if no UUID is provided

            -
              • (uuid): Promise<Nullable<Person>>

              • Parameters

                • uuid: string

                  the UUID of the person to retrieve

                  +

                Returns boolean

          • person: {
                getByUuid: ((uuid: string) => Promise<Nullable<Person>>);
                getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>);
            }
            • getByUuid: ((uuid: string) => Promise<Nullable<Person>>)

              Returns a person by their UUID.

              +

              Throws

              Error if no UUID is provided

              +
                • (uuid): Promise<Nullable<Person>>

                • Parameters

                  • uuid: string

                    the UUID of the person to retrieve

                  Returns Promise<Nullable<Person>>

                  the person or null if no person is found for the UUID

            • getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PersonWithLineage>>)

              Returns a person by their UUID along with the person's parent lineage.

              -

              Throws

              Error if no UUID is provided

              -
                • (uuid): Promise<Nullable<PersonWithLineage>>

                • Parameters

                  • uuid: string

                    the UUID of the person to retrieve

                    +

                    Throws

                    Error if no UUID is provided

                    +
                  • getPageByType: ((personType: string, cursor?: Nullable<string>, limit?: number) => Promise<Page<Person>>)

                    Returns an array of people for the provided page specifications.

                    -

                    Throws

                    Error if no type is provided or if the type is not for a person

                    -

                    Throws

                    Error if the provided limit is <= 0

                    -

                    Throws

                    Error if the provided cursor is not a valid page token or null

                    -

                    See

                    getByType which provides the same data, but without having to manually account for paging

                    -
                      • (personType, cursor?, limit?): Promise<Page<Person>>

                      • Parameters

                        • personType: string

                          the type of people to return

                          -
                        • cursor: Nullable<string> = null

                          the token identifying which page to retrieve. A null value indicates the first page should be -returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.

                          -
                        • limit: number = 100

                          the maximum number of people to return. Default is 100.

                          -

                        Returns Promise<Page<Person>>

                        a page of people for the provided specifications

                • place: {
                      getByUuid: ((uuid: string) => Promise<Nullable<Place>>);
                      getByUuidWithLineage: ((uuid: string) => Promise<Nullable<PlaceWithLineage>>);
                  }
                  • getByUuid: ((uuid: string) => Promise<Nullable<Place>>)

                    Returns a place by its UUID.

                    -

                    Throws

                    Error if no UUID is provided

                    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index 96b965e..7c9fa4b 100644 --- a/functions/getLocalDataContext.html +++ b/functions/getLocalDataContext.html @@ -4,4 +4,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getRemoteDataContext.html b/functions/getRemoteDataContext.html index bb1e8d5..0ad31b4 100644 --- a/functions/getRemoteDataContext.html +++ b/functions/getRemoteDataContext.html @@ -3,4 +3,4 @@

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/interfaces/DataContext.html b/interfaces/DataContext.html index 930a4f2..644263f 100644 --- a/interfaces/DataContext.html +++ b/interfaces/DataContext.html @@ -1,8 +1,8 @@ DataContext | @medic/cht-datasource

Interface DataContext

Context for interacting with the data. This may represent a local data context where data can be accessed even while offline. Or it may represent a remote data context where all data operations are performed against a remote CHT instance.

-
interface DataContext {
    bind: (<T>(fn: ((ctx: DataContext) => T)) => T);
}

Properties

bind +
interface DataContext {
    bind: (<T>(fn: ((ctx: DataContext) => T)) => T);
}

Properties

bind

Properties

bind

bind: (<T>(fn: ((ctx: DataContext) => T)) => T)

Executes the provided function with this data context as the argument.

Type declaration

    • <T>(fn): T

    • Type Parameters

      • T

      Parameters

      Returns T

      the result of the function

      -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Person.v1.Person.html b/interfaces/Person.v1.Person.html index 9b22d62..d5ddd48 100644 --- a/interfaces/Person.v1.Person.html +++ b/interfaces/Person.v1.Person.html @@ -1,5 +1,5 @@ Person | @medic/cht-datasource

Interface Person

Immutable data about a person contact.

-
interface Person {
    _id: string;
    _rev: string;
    contact_type?: string;
    date_of_birth?: Date;
    name?: string;
    parent?: NormalizedParent;
    patient_id?: string;
    phone?: string;
    reported_date?: Date;
    sex?: string;
    type: string;
}

Hierarchy (view full)

Properties

_id +
interface Person {
    _id: string;
    _rev: string;
    contact_type?: string;
    date_of_birth?: Date;
    name?: string;
    parent?: NormalizedParent;
    patient_id?: string;
    phone?: string;
    reported_date?: Date;
    sex?: string;
    type: string;
}

Hierarchy (view full)

Properties

_id _rev contact_type? date_of_birth? @@ -10,4 +10,4 @@ reported_date? sex? type -

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact_type

contact_type?: string

Optional Readonlydate_of_birth

date_of_birth?: Date

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent

Optional Readonlypatient_id

patient_id?: string

Optional Readonlyphone

phone?: string

Optional Readonlyreported_date

reported_date?: Date

Optional Readonlysex

sex?: string

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact_type

contact_type?: string

Optional Readonlydate_of_birth

date_of_birth?: Date

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent

Optional Readonlypatient_id

patient_id?: string

Optional Readonlyphone

phone?: string

Optional Readonlyreported_date

reported_date?: Date

Optional Readonlysex

sex?: string

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Person.v1.PersonWithLineage.html b/interfaces/Person.v1.PersonWithLineage.html index a6b1a77..986b7d3 100644 --- a/interfaces/Person.v1.PersonWithLineage.html +++ b/interfaces/Person.v1.PersonWithLineage.html @@ -1,5 +1,5 @@ PersonWithLineage | @medic/cht-datasource

Interface PersonWithLineage

Immutable data about a person contact, including the full records of the parent place lineage.

-
interface PersonWithLineage {
    _id: string;
    _rev: string;
    contact_type?: string;
    date_of_birth?: Date;
    name?: string;
    parent?: NormalizedParent | PlaceWithLineage;
    patient_id?: string;
    phone?: string;
    reported_date?: Date;
    sex?: string;
    type: string;
}

Hierarchy (view full)

Properties

_id +
interface PersonWithLineage {
    _id: string;
    _rev: string;
    contact_type?: string;
    date_of_birth?: Date;
    name?: string;
    parent?: NormalizedParent | PlaceWithLineage;
    patient_id?: string;
    phone?: string;
    reported_date?: Date;
    sex?: string;
    type: string;
}

Hierarchy (view full)

Properties

_id _rev contact_type? date_of_birth? @@ -10,4 +10,4 @@ reported_date? sex? type -

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact_type

contact_type?: string

Optional Readonlydate_of_birth

date_of_birth?: Date

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent | PlaceWithLineage

Optional Readonlypatient_id

patient_id?: string

Optional Readonlyphone

phone?: string

Optional Readonlyreported_date

reported_date?: Date

Optional Readonlysex

sex?: string

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact_type

contact_type?: string

Optional Readonlydate_of_birth

date_of_birth?: Date

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent | PlaceWithLineage

Optional Readonlypatient_id

patient_id?: string

Optional Readonlyphone

phone?: string

Optional Readonlyreported_date

reported_date?: Date

Optional Readonlysex

sex?: string

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Place.v1.Place.html b/interfaces/Place.v1.Place.html index aa0e9c4..488a49e 100644 --- a/interfaces/Place.v1.Place.html +++ b/interfaces/Place.v1.Place.html @@ -1,5 +1,5 @@ Place | @medic/cht-datasource

Interface Place

Immutable data about a place contact.

-
interface Place {
    _id: string;
    _rev: string;
    contact?: NormalizedParent;
    contact_type?: string;
    name?: string;
    parent?: NormalizedParent;
    place_id?: string;
    reported_date?: Date;
    type: string;
}

Hierarchy (view full)

Properties

_id +
interface Place {
    _id: string;
    _rev: string;
    contact?: NormalizedParent;
    contact_type?: string;
    name?: string;
    parent?: NormalizedParent;
    place_id?: string;
    reported_date?: Date;
    type: string;
}

Hierarchy (view full)

Properties

_id _rev contact? contact_type? @@ -8,4 +8,4 @@ place_id? reported_date? type -

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact

contact?: NormalizedParent

Optional Readonlycontact_type

contact_type?: string

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent

Optional Readonlyplace_id

place_id?: string

Optional Readonlyreported_date

reported_date?: Date

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact

contact?: NormalizedParent

Optional Readonlycontact_type

contact_type?: string

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent

Optional Readonlyplace_id

place_id?: string

Optional Readonlyreported_date

reported_date?: Date

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/interfaces/Place.v1.PlaceWithLineage.html b/interfaces/Place.v1.PlaceWithLineage.html index 0a94b97..558738d 100644 --- a/interfaces/Place.v1.PlaceWithLineage.html +++ b/interfaces/Place.v1.PlaceWithLineage.html @@ -1,6 +1,6 @@ PlaceWithLineage | @medic/cht-datasource

Interface PlaceWithLineage

Immutable data about a place contact, including the full records of the parent place lineage and the primary contact for the place.

-
interface PlaceWithLineage {
    _id: string;
    _rev: string;
    contact?: NormalizedParent | PersonWithLineage;
    contact_type?: string;
    name?: string;
    parent?: NormalizedParent | PlaceWithLineage;
    place_id?: string;
    reported_date?: Date;
    type: string;
}

Hierarchy (view full)

Properties

_id +
interface PlaceWithLineage {
    _id: string;
    _rev: string;
    contact?: NormalizedParent | PersonWithLineage;
    contact_type?: string;
    name?: string;
    parent?: NormalizedParent | PlaceWithLineage;
    place_id?: string;
    reported_date?: Date;
    type: string;
}

Hierarchy (view full)

Properties

_id _rev contact? contact_type? @@ -9,4 +9,4 @@ place_id? reported_date? type -

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact

contact?: NormalizedParent | PersonWithLineage

Optional Readonlycontact_type

contact_type?: string

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent | PlaceWithLineage

Optional Readonlyplace_id

place_id?: string

Optional Readonlyreported_date

reported_date?: Date

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Readonly_id

_id: string

Readonly_rev

_rev: string

Optional Readonlycontact

contact?: NormalizedParent | PersonWithLineage

Optional Readonlycontact_type

contact_type?: string

Optional Readonlyname

name?: string

Optional Readonlyparent

parent?: NormalizedParent | PlaceWithLineage

Optional Readonlyplace_id

place_id?: string

Optional Readonlyreported_date

reported_date?: Date

Readonlytype

type: string

Settings

Member Visibility

On This Page

Properties
diff --git a/modules.html b/modules.html index 846c878..61eefa2 100644 --- a/modules.html +++ b/modules.html @@ -1,7 +1,6 @@ @medic/cht-datasource

@medic/cht-datasource

Index

Namespaces

Person Place Qualifier -

Classes

InvalidArgumentError

Interfaces

DataContext

Type Aliases

NonEmptyArray Nullable diff --git a/modules/Person.html b/modules/Person.html index ab520c8..8014648 100644 --- a/modules/Person.html +++ b/modules/Person.html @@ -1,2 +1,2 @@ -Person | @medic/cht-datasource

Namespace Person

Index

Namespaces

v1 +Person | @medic/cht-datasource

Namespace Person

Index

Namespaces

v1

Settings

Member Visibility
diff --git a/modules/Person.v1.html b/modules/Person.v1.html index 204e681..4eb9ac1 100644 --- a/modules/Person.v1.html +++ b/modules/Person.v1.html @@ -1,7 +1,5 @@ -v1 | @medic/cht-datasource

Namespace v1

Index

Interfaces

Person +v1 | @medic/cht-datasource

Namespace v1

Index

Interfaces

Person PersonWithLineage

Functions

get -getAll -getPage getWithLineage

Settings

Member Visibility
diff --git a/modules/Place.html b/modules/Place.html index b9425bc..d71e57e 100644 --- a/modules/Place.html +++ b/modules/Place.html @@ -1,2 +1,2 @@ -Place | @medic/cht-datasource

Namespace Place

Index

Namespaces

v1 +Place | @medic/cht-datasource

Namespace Place

Index

Namespaces

v1

Settings

Member Visibility
diff --git a/modules/Place.v1.html b/modules/Place.v1.html index 43c7d03..d3f6de6 100644 --- a/modules/Place.v1.html +++ b/modules/Place.v1.html @@ -1,4 +1,4 @@ -v1 | @medic/cht-datasource

Namespace v1

Index

Interfaces

Place +v1 | @medic/cht-datasource

Namespace v1

Index

Interfaces

Place PlaceWithLineage

Functions

get getWithLineage diff --git a/modules/Qualifier.html b/modules/Qualifier.html index 1ab4447..e215011 100644 --- a/modules/Qualifier.html +++ b/modules/Qualifier.html @@ -1,7 +1,4 @@ -Qualifier | @medic/cht-datasource

Namespace Qualifier

Index

Type Aliases

ContactTypeQualifier -UuidQualifier -

Functions

byContactType -byUuid -isContactTypeQualifier +Qualifier | @medic/cht-datasource

Namespace Qualifier

Index

Type Aliases

UuidQualifier +

Functions

byUuid isUuidQualifier

Settings

Member Visibility
diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index 86d440c..9d21bd6 100644 --- a/types/NonEmptyArray.html +++ b/types/NonEmptyArray.html @@ -1,2 +1,2 @@ NonEmptyArray | @medic/cht-datasource

Type Alias NonEmptyArray<T>

NonEmptyArray<T>: [T, ...T[]]

An array that is guaranteed to have at least one element.

-

Type Parameters

  • T

Settings

Member Visibility
+

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/Nullable.html b/types/Nullable.html index 1e19a37..917b10a 100644 --- a/types/Nullable.html +++ b/types/Nullable.html @@ -1,2 +1,2 @@ Nullable | @medic/cht-datasource

Type Alias Nullable<T>

Nullable<T>: T | null

A value that could be null.

-

Type Parameters

  • T

Settings

Member Visibility
+

Type Parameters

  • T

Settings

Member Visibility
diff --git a/types/Qualifier.ContactTypeQualifier.html b/types/Qualifier.ContactTypeQualifier.html deleted file mode 100644 index 78c4344..0000000 --- a/types/Qualifier.ContactTypeQualifier.html +++ /dev/null @@ -1,2 +0,0 @@ -ContactTypeQualifier | @medic/cht-datasource

Type Alias ContactTypeQualifier

ContactTypeQualifier: Readonly<{
    contactType: string;
}>

A qualifier that identifies contacts based on type.

-

Settings

Member Visibility
diff --git a/types/Qualifier.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index 297c451..85740c0 100644 --- a/types/Qualifier.UuidQualifier.html +++ b/types/Qualifier.UuidQualifier.html @@ -1,2 +1,2 @@ UuidQualifier | @medic/cht-datasource

Type Alias UuidQualifier

UuidQualifier: Readonly<{
    uuid: string;
}>

A qualifier that identifies an entity by its UUID.

-

Settings

Member Visibility
+

Settings

Member Visibility