diff --git a/functions/Person.v1.get.html b/functions/Person.v1.get.html index d1faa58..c4eff93 100644 --- a/functions/Person.v1.get.html +++ b/functions/Person.v1.get.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<Person>>)

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

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Person.v1.getWithLineage.html b/functions/Person.v1.getWithLineage.html index 1eb6d74..901997d 100644 --- a/functions/Person.v1.getWithLineage.html +++ b/functions/Person.v1.getWithLineage.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<PersonWithLineage>>)

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

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Place.v1.get.html b/functions/Place.v1.get.html index 71f49b4..4a408b3 100644 --- a/functions/Place.v1.get.html +++ b/functions/Place.v1.get.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<Place>>)

the place or null if no place is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Place.v1.getWithLineage.html b/functions/Place.v1.getWithLineage.html index f0f3228..6a99283 100644 --- a/functions/Place.v1.getWithLineage.html +++ b/functions/Place.v1.getWithLineage.html @@ -2,4 +2,4 @@

Parameters

Returns ((qualifier) => Promise<Nullable<PlaceWithLineage>>)

the place or null if no place is found for the qualifier

Throws

Error if the provided context or qualifier is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Qualifier.byUuid.html b/functions/Qualifier.byUuid.html index 548ad9a..395afca 100644 --- a/functions/Qualifier.byUuid.html +++ b/functions/Qualifier.byUuid.html @@ -2,4 +2,4 @@

Parameters

Returns Readonly<{
    uuid: string;
}>

the qualifier

Throws

Error if the UUID is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/Qualifier.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index 6b2327b..bbaea89 100644 --- a/functions/Qualifier.isUuidQualifier.html +++ b/functions/Qualifier.isUuidQualifier.html @@ -2,4 +2,4 @@

Parameters

Returns identifier is Readonly<{
    uuid: string;
}>

true if the given identifier is a UuidQualifier, otherwise false

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/getDatasource.html b/functions/getDatasource.html index cfdd9b2..05e30ff 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -26,4 +26,4 @@

Throws

Error if no UUID is provided

Throws

Error if no UUID is provided

Throws

Error if the provided context is invalid

-

Settings

Member Visibility

Theme

\ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index 2dd100c..933f7c1 100644 --- a/functions/getLocalDataContext.html +++ b/functions/getLocalDataContext.html @@ -4,4 +4,4 @@
  • sourceDatabases: Readonly<{
        medic: Database<Doc>;
    }>

    the PouchDB databases to use as the local datasource

    • Returns DataContext

    the local data context

    Throws

    Error if the provided settings or source databases are invalid

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/functions/getRemoteDataContext.html b/functions/getRemoteDataContext.html index 13f540f..b58bac9 100644 --- a/functions/getRemoteDataContext.html +++ b/functions/getRemoteDataContext.html @@ -3,4 +3,4 @@

    Parameters

    Returns DataContext

    the data context

    -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/interfaces/DataContext.html b/interfaces/DataContext.html index 29c94f9..570c642 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) => T);
    }

    Properties

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

    Properties

    bind

    Properties

    bind

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

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

    Type declaration

      • <T>(fn): T

      • Type Parameters

        • T

        Parameters

        • fn: ((ctx) => T)

          the function to execute

        Returns T

    Returns

    the result of the function

    -

    Settings

    Member Visibility

    Theme

    On This Page

    bind
    \ No newline at end of file +

    Settings

    Member Visibility

    Theme

    On This Page

    bind
    \ No newline at end of file diff --git a/interfaces/Person.v1.Person.html b/interfaces/Person.v1.Person.html index 37ff501..5b5a3a2 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 Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file diff --git a/interfaces/Person.v1.PersonWithLineage.html b/interfaces/Person.v1.PersonWithLineage.html index 7d20720..6f380af 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 Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly date_of_birth

    date_of_birth?: Date

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly patient_id

    patient_id?: string

    Optional Readonly phone

    phone?: string

    Optional Readonly reported_date

    reported_date?: Date

    Optional Readonly sex

    sex?: string

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontact_typedate_of_birthnameparentpatient_idphonereported_datesextype
    \ No newline at end of file diff --git a/interfaces/Place.v1.Place.html b/interfaces/Place.v1.Place.html index da9170e..6fe9a8c 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 Readonly contact

    contact?: NormalizedParent

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file diff --git a/interfaces/Place.v1.PlaceWithLineage.html b/interfaces/Place.v1.PlaceWithLineage.html index 47e03ac..d560692 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 Readonly contact

    contact?: NormalizedParent | PersonWithLineage

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file +

    Properties

    Readonly _id

    _id: string

    Readonly _rev

    _rev: string

    Optional Readonly contact

    contact?: NormalizedParent | PersonWithLineage

    Optional Readonly contact_type

    contact_type?: string

    Optional Readonly name

    name?: string

    Optional Readonly parent

    parent?: NormalizedParent | PlaceWithLineage

    Optional Readonly place_id

    place_id?: string

    Optional Readonly reported_date

    reported_date?: Date

    Readonly type

    type: string

    Settings

    Member Visibility

    Theme

    On This Page

    _id_revcontactcontact_typenameparentplace_idreported_datetype
    \ No newline at end of file diff --git a/modules/Person.html b/modules/Person.html index 7ee7be6..6915eb2 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

    Theme

    \ No newline at end of file diff --git a/modules/Person.v1.html b/modules/Person.v1.html index bcebcd4..689af09 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 getWithLineage diff --git a/modules/Place.html b/modules/Place.html index f9359a5..2d23288 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

    Theme

    \ No newline at end of file diff --git a/modules/Place.v1.html b/modules/Place.v1.html index 8b6aa27..15bbb6f 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 6533553..cc0bc5b 100644 --- a/modules/Qualifier.html +++ b/modules/Qualifier.html @@ -1,4 +1,4 @@ -Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    UuidQualifier +Qualifier | @medic/cht-datasource

    Namespace Qualifier

    Index

    Type Aliases

    UuidQualifier

    Functions

    byUuid isUuidQualifier

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index e8a9936..84ce8fa 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

    Theme

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Nullable.html b/types/Nullable.html index 8164fff..8ce0c92 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

    Theme

    \ No newline at end of file +

    Type Parameters

    • T

    Settings

    Member Visibility

    Theme

    \ No newline at end of file diff --git a/types/Qualifier.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index ece75d8..997c552 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.

    -

    Type declaration

    • uuid: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

    Type declaration

    • uuid: string

    Settings

    Member Visibility

    Theme

    \ No newline at end of file