From 3c3babd49c3c1f15471ed3a3e07b8d3bdcd4e822 Mon Sep 17 00:00:00 2001 From: medic-ci Date: Mon, 11 Nov 2024 18:24:32 +0000 Subject: [PATCH] deploy: medic/cht-core@b2fd7398abfb4ad5353b8d95bec3ec24c489027f --- 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 95347e4..0f3ac98 100644 --- a/classes/InvalidArgumentError.html +++ b/classes/InvalidArgumentError.html @@ -1,7 +1,7 @@ InvalidArgumentError | @medic/cht-datasource

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

Hierarchy

  • Error
    • InvalidArgumentError

Constructors

Properties

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

Methods

Constructors

Properties

cause?: unknown
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

+

Returns InvalidArgumentError

Properties

cause?: unknown
message: string
name: string
stack?: string
prepareStackTrace?: ((err: Error, stackTraces: CallSite[]) => any)

Optional override for formatting stack traces

stackTraceLimit: number

Methods

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

diff --git a/functions/Person.v1.get.html b/functions/Person.v1.get.html index 9e2096e..1bf503e 100644 --- a/functions/Person.v1.get.html +++ b/functions/Person.v1.get.html @@ -2,4 +2,4 @@

Error if the provided context or qualifier is invalid

+
diff --git a/functions/Person.v1.getAll.html b/functions/Person.v1.getAll.html index e837d86..767dc83 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

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

-
+
diff --git a/functions/Person.v1.getPage.html b/functions/Person.v1.getPage.html index 8d715ea..cbed937 100644 --- a/functions/Person.v1.getPage.html +++ b/functions/Person.v1.getPage.html @@ -12,4 +12,4 @@

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

Error if the provided limit value is <=0

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

-
+
diff --git a/functions/Person.v1.getWithLineage.html b/functions/Person.v1.getWithLineage.html index 78c4e41..b6db601 100644 --- a/functions/Person.v1.getWithLineage.html +++ b/functions/Person.v1.getWithLineage.html @@ -2,4 +2,4 @@

Error if the provided context or qualifier is invalid

+
diff --git a/functions/Place.v1.get.html b/functions/Place.v1.get.html index 1190b99..72d7ca3 100644 --- a/functions/Place.v1.get.html +++ b/functions/Place.v1.get.html @@ -2,4 +2,4 @@

Error if the provided context or qualifier is invalid

+
diff --git a/functions/Place.v1.getAll.html b/functions/Place.v1.getAll.html index 31f9636..d524236 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

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

-
+
diff --git a/functions/Place.v1.getPage.html b/functions/Place.v1.getPage.html index 45b26d3..60472a4 100644 --- a/functions/Place.v1.getPage.html +++ b/functions/Place.v1.getPage.html @@ -12,4 +12,4 @@

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

Error if the provided limit value is <=0

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

-
+
diff --git a/functions/Place.v1.getWithLineage.html b/functions/Place.v1.getWithLineage.html index 0e97f63..32b56b0 100644 --- a/functions/Place.v1.getWithLineage.html +++ b/functions/Place.v1.getWithLineage.html @@ -2,4 +2,4 @@

Error if the provided context or qualifier is invalid

+
diff --git a/functions/Qualifier.byContactType.html b/functions/Qualifier.byContactType.html index 1a79f7a..07640f8 100644 --- a/functions/Qualifier.byContactType.html +++ b/functions/Qualifier.byContactType.html @@ -2,4 +2,4 @@

Error if the type is invalid

+
diff --git a/functions/Qualifier.byUuid.html b/functions/Qualifier.byUuid.html index f9e142a..3b0bb48 100644 --- a/functions/Qualifier.byUuid.html +++ b/functions/Qualifier.byUuid.html @@ -2,4 +2,4 @@

Error if the UUID is invalid

+
diff --git a/functions/Qualifier.isContactTypeQualifier.html b/functions/Qualifier.isContactTypeQualifier.html index b7afbe2..b8d9167 100644 --- a/functions/Qualifier.isContactTypeQualifier.html +++ b/functions/Qualifier.isContactTypeQualifier.html @@ -1,4 +1,4 @@ isContactTypeQualifier | @medic/cht-datasource

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

  • Parameters

    • contactType: unknown

      the type to check

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

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

    -
+
diff --git a/functions/Qualifier.isUuidQualifier.html b/functions/Qualifier.isUuidQualifier.html index 5c12805..eb8eb88 100644 --- a/functions/Qualifier.isUuidQualifier.html +++ b/functions/Qualifier.isUuidQualifier.html @@ -2,4 +2,4 @@
+
diff --git a/functions/getDatasource.html b/functions/getDatasource.html index ccd5dc8..2c92be2 100644 --- a/functions/getDatasource.html +++ b/functions/getDatasource.html @@ -54,4 +54,4 @@ returned. Subsequent pages can be retrieved by providing the cursor returned with the previous page.

  • 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

    -
    +
    diff --git a/functions/getLocalDataContext.html b/functions/getLocalDataContext.html index c3cd1b5..cccccbf 100644 --- a/functions/getLocalDataContext.html +++ b/functions/getLocalDataContext.html @@ -4,4 +4,4 @@
    +
    diff --git a/functions/getRemoteDataContext.html b/functions/getRemoteDataContext.html index 3db3555..d21bafb 100644 --- a/functions/getRemoteDataContext.html +++ b/functions/getRemoteDataContext.html @@ -3,4 +3,4 @@
    +
    diff --git a/interfaces/DataContext.html b/interfaces/DataContext.html index da72197..076e08f 100644 --- a/interfaces/DataContext.html +++ b/interfaces/DataContext.html @@ -1,8 +1,8 @@ DataContext | @medic/cht-datasource

    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

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

    Properties

    Properties

    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

        -
    +
    diff --git a/interfaces/Person.v1.Person.html b/interfaces/Person.v1.Person.html index 5a085c1..27618ac 100644 --- a/interfaces/Person.v1.Person.html +++ b/interfaces/Person.v1.Person.html @@ -1,5 +1,5 @@ Person | @medic/cht-datasource

    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: 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
    +

    Properties

    _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
    diff --git a/interfaces/Person.v1.PersonWithLineage.html b/interfaces/Person.v1.PersonWithLineage.html index 6388353..b926596 100644 --- a/interfaces/Person.v1.PersonWithLineage.html +++ b/interfaces/Person.v1.PersonWithLineage.html @@ -1,5 +1,5 @@ PersonWithLineage | @medic/cht-datasource

    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: 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
    +

    Properties

    _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
    diff --git a/interfaces/Place.v1.Place.html b/interfaces/Place.v1.Place.html index 8f6b6c7..fd22ac0 100644 --- a/interfaces/Place.v1.Place.html +++ b/interfaces/Place.v1.Place.html @@ -1,5 +1,5 @@ Place | @medic/cht-datasource

    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: string
    _rev: string
    contact?: NormalizedParent
    contact_type?: string
    name?: string
    parent?: NormalizedParent
    place_id?: string
    reported_date?: Date
    type: string
    +

    Properties

    _id: string
    _rev: string
    contact?: NormalizedParent
    contact_type?: string
    name?: string
    parent?: NormalizedParent
    place_id?: string
    reported_date?: Date
    type: string
    diff --git a/interfaces/Place.v1.PlaceWithLineage.html b/interfaces/Place.v1.PlaceWithLineage.html index 9f56c07..b1f9c38 100644 --- a/interfaces/Place.v1.PlaceWithLineage.html +++ b/interfaces/Place.v1.PlaceWithLineage.html @@ -1,6 +1,6 @@ PlaceWithLineage | @medic/cht-datasource

    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: string
    _rev: string
    contact?: NormalizedParent | PersonWithLineage
    contact_type?: string
    name?: string
    parent?: NormalizedParent | PlaceWithLineage
    place_id?: string
    reported_date?: Date
    type: string
    +

    Properties

    _id: string
    _rev: string
    contact?: NormalizedParent | PersonWithLineage
    contact_type?: string
    name?: string
    parent?: NormalizedParent | PlaceWithLineage
    place_id?: string
    reported_date?: Date
    type: string
    diff --git a/modules/Person.html b/modules/Person.html index e1b564f..7684edb 100644 --- a/modules/Person.html +++ b/modules/Person.html @@ -1,2 +1,2 @@ -Person | @medic/cht-datasource

    Index

    Namespaces

    v1 +Person | @medic/cht-datasource
    diff --git a/modules/Person.v1.html b/modules/Person.v1.html index 04f3fa8..0c40e83 100644 --- a/modules/Person.v1.html +++ b/modules/Person.v1.html @@ -1,4 +1,4 @@ -v1 | @medic/cht-datasource

    Index

    Interfaces

    Person +v1 | @medic/cht-datasource

    Index

    Interfaces

    Functions

    get getAll diff --git a/modules/Place.html b/modules/Place.html index 6f25b42..9848272 100644 --- a/modules/Place.html +++ b/modules/Place.html @@ -1,2 +1,2 @@ -Place | @medic/cht-datasource

    Index

    Namespaces

    v1 +Place | @medic/cht-datasource
    diff --git a/modules/Place.v1.html b/modules/Place.v1.html index 2951bab..a505b6c 100644 --- a/modules/Place.v1.html +++ b/modules/Place.v1.html @@ -1,4 +1,4 @@ -v1 | @medic/cht-datasource

    Index

    Interfaces

    Place +v1 | @medic/cht-datasource

    Index

    Interfaces

    Functions

    get getAll diff --git a/modules/Qualifier.html b/modules/Qualifier.html index 31f2c61..9b8f31d 100644 --- a/modules/Qualifier.html +++ b/modules/Qualifier.html @@ -1,4 +1,4 @@ -Qualifier | @medic/cht-datasource

    Index

    Type Aliases

    ContactTypeQualifier +Qualifier | @medic/cht-datasource

    Index

    Type Aliases

    Functions

    byContactType byUuid diff --git a/types/NonEmptyArray.html b/types/NonEmptyArray.html index e1d209f..18e6fe6 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
    +

    Type Parameters

    • T
    diff --git a/types/Nullable.html b/types/Nullable.html index 266bd5e..68caa7a 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
    +

    Type Parameters

    • T
    diff --git a/types/Qualifier.ContactTypeQualifier.html b/types/Qualifier.ContactTypeQualifier.html index cc6ccb1..3946ccf 100644 --- a/types/Qualifier.ContactTypeQualifier.html +++ b/types/Qualifier.ContactTypeQualifier.html @@ -1,2 +1,2 @@ ContactTypeQualifier | @medic/cht-datasource
    ContactTypeQualifier: Readonly<{
        contactType: string;
    }>

    A qualifier that identifies contacts based on type.

    -
    +
    diff --git a/types/Qualifier.UuidQualifier.html b/types/Qualifier.UuidQualifier.html index b4423a8..89008fe 100644 --- a/types/Qualifier.UuidQualifier.html +++ b/types/Qualifier.UuidQualifier.html @@ -1,2 +1,2 @@ UuidQualifier | @medic/cht-datasource
    UuidQualifier: Readonly<{
        uuid: string;
    }>

    A qualifier that identifies an entity by its UUID.

    -
    +