diff --git a/functions/Person.v1.get.html b/functions/Person.v1.get.html index f0bb87d..f2b0ca2 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.getWithLineage.html b/functions/Person.v1.getWithLineage.html index ba21885..030be88 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 09b185b..2d3f668 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 26c4e4f..889902f 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.byUuid.html b/functions/Qualifier.byUuid.html index 61b3d68..fcfccc4 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.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index d6da077..bca629d 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 9bdceea..1828fb5 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -26,4 +26,4 @@

Throws

Error if no UUID is provided

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index 4a32a23..66d4781 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 dd7a192..06d931b 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 99a025c..88c28d2 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 2fef909..68c43ab 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 5b9b88e..dbe71f3 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 76b6790..b872172 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 efef632..f4913a3 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 20eef71..d206e5f 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 e933d02..0cc9ae8 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 9017a29..a101d38 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 eb035ae..49d87d8 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 15b5773..63f76c7 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
diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index 4bc14f2..2e1a5c1 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 dae92df..b03259f 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.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index 32cda04..7e84a27 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