From bd8c706b20cc22ae504e37015eb57656837b9c35 Mon Sep 17 00:00:00 2001 From: medic-ci Date: Wed, 9 Oct 2024 09:03:32 +0000 Subject: [PATCH] deploy: medic/cht-core@0efce626d8459cdd75fc49a3427b0ab77e3f1dfd --- classes/InvalidArgumentError.html | 4 ++-- functions/Person.v1.get.html | 2 +- functions/Person.v1.getAll.html | 2 +- functions/Person.v1.getPage.html | 2 +- functions/Person.v1.getWithLineage.html | 2 +- functions/Place.v1.get.html | 2 +- functions/Place.v1.getAll.html | 2 +- functions/Place.v1.getPage.html | 2 +- functions/Place.v1.getWithLineage.html | 2 +- functions/Qualifier.byContactType.html | 2 +- functions/Qualifier.byUuid.html | 2 +- functions/Qualifier.isContactTypeQualifier.html | 2 +- functions/Qualifier.isUuidQualifier.html | 2 +- functions/getDatasource.html | 2 +- functions/getLocalDataContext.html | 2 +- functions/getRemoteDataContext.html | 2 +- interfaces/DataContext.html | 4 ++-- interfaces/Person.v1.Person.html | 4 ++-- interfaces/Person.v1.PersonWithLineage.html | 4 ++-- interfaces/Place.v1.Place.html | 4 ++-- interfaces/Place.v1.PlaceWithLineage.html | 4 ++-- modules/Person.html | 2 +- modules/Person.v1.html | 2 +- modules/Place.html | 2 +- modules/Place.v1.html | 2 +- modules/Qualifier.html | 2 +- types/NonEmptyArray.html | 2 +- types/Nullable.html | 2 +- types/Qualifier.ContactTypeQualifier.html | 2 +- types/Qualifier.UuidQualifier.html | 2 +- 30 files changed, 36 insertions(+), 36 deletions(-) diff --git a/classes/InvalidArgumentError.html b/classes/InvalidArgumentError.html index 088aa9d..5136e3a 100644 --- a/classes/InvalidArgumentError.html +++ b/classes/InvalidArgumentError.html @@ -1,7 +1,7 @@ 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 +

Hierarchy

  • Error
    • InvalidArgumentError

Constructors

constructor

Properties

cause? message name @@ -11,7 +11,7 @@

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

+

Returns InvalidArgumentError

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 fe06aba..b8b0562 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 index a36de88..5951a48 100644 --- a/functions/Person.v1.getAll.html +++ b/functions/Person.v1.getAll.html @@ -6,4 +6,4 @@

Parameters

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
+

Settings

Member Visibility
diff --git a/functions/Person.v1.getPage.html b/functions/Person.v1.getPage.html index df598c2..a5a19e4 100644 --- a/functions/Person.v1.getPage.html +++ b/functions/Person.v1.getPage.html @@ -12,4 +12,4 @@

See

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
+

Settings

Member Visibility
diff --git a/functions/Person.v1.getWithLineage.html b/functions/Person.v1.getWithLineage.html index 27b5ba3..eea1026 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 a10ec1f..c2f1950 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.getAll.html b/functions/Place.v1.getAll.html index afbc6dc..f262e47 100644 --- a/functions/Place.v1.getAll.html +++ b/functions/Place.v1.getAll.html @@ -6,4 +6,4 @@

Parameters

Returns AsyncGenerator<Place, null, unknown>

a generator for fetching all places with the given type

Throws

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

-

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Place.v1.getPage.html b/functions/Place.v1.getPage.html index f1c9b74..8358f1b 100644 --- a/functions/Place.v1.getPage.html +++ b/functions/Place.v1.getPage.html @@ -12,4 +12,4 @@

See

Throws

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

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
+

Settings

Member Visibility
diff --git a/functions/Place.v1.getWithLineage.html b/functions/Place.v1.getWithLineage.html index 63af411..b91fb00 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 index 66cf966..006ebd1 100644 --- a/functions/Qualifier.byContactType.html +++ b/functions/Qualifier.byContactType.html @@ -2,4 +2,4 @@

Throws

Error if the type is invalid

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/Qualifier.byUuid.html b/functions/Qualifier.byUuid.html index 92dca60..36a8d2c 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 index 7ea6555..5bcf520 100644 --- a/functions/Qualifier.isContactTypeQualifier.html +++ b/functions/Qualifier.isContactTypeQualifier.html @@ -1,4 +1,4 @@ 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
+

Settings

Member Visibility
diff --git a/functions/Qualifier.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index dce7641..2da509a 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 d02c1b7..545d9bc 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -54,4 +54,4 @@

See
  • limit: number = 100

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

    • Returns Promise<Page<Place>>

    a page of places for the provided specifications

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index 8646053..0506564 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 984c0e2..df0adc1 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 db85e65..01bd0a3 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 1c3230c..3124681 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 e3b4495..682e1ef 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 a657bae..457f314 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 7a3fcc2..073de4c 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/Person.html b/modules/Person.html index 11296fc..62511e0 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 7545724..73c9c82 100644 --- a/modules/Person.v1.html +++ b/modules/Person.v1.html @@ -1,4 +1,4 @@ -v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Person +v1 | @medic/cht-datasource

    Namespace v1

    Index

    Interfaces

    Person PersonWithLineage

    Functions

    get getAll diff --git a/modules/Place.html b/modules/Place.html index 100d56d..95a69c3 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 e92fa64..ddfdf7f 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 getAll diff --git a/modules/Qualifier.html b/modules/Qualifier.html index 45da092..b1e7481 100644 --- a/modules/Qualifier.html +++ b/modules/Qualifier.html @@ -1,4 +1,4 @@ -Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    ContactTypeQualifier +Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    ContactTypeQualifier UuidQualifier

    Functions

    byContactType byUuid diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index 24593d9..2feb769 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 939bd37..63afbda 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 index d9d6f91..79f90ce 100644 --- a/types/Qualifier.ContactTypeQualifier.html +++ b/types/Qualifier.ContactTypeQualifier.html @@ -1,2 +1,2 @@ ContactTypeQualifier | @medic/cht-datasource

    Type Alias ContactTypeQualifier

    ContactTypeQualifier: Readonly<{
        contactType: string;
    }>

    A qualifier that identifies contacts based on type.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/Qualifier.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index a92ab69..6187019 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