Class DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>

Type Parameters

TDataStore extends "/home/runner/work/comapeo-core/comapeo-core/src/datastore/index"
TTable extends MapeoDocTables
TSchemaName extends TTable["_"]["name"]
TDoc extends MapeoDocMap[TSchemaName]
TValue extends MapeoValueMap[TSchemaName]

Hierarchy

TypedEmitter<DataTypeEvents<TDoc>>
- DataType

Index

Constructors

constructor

new DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>(__namedParameters): DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>
Type Parameters
- TDataStore extends DataStore<"auth" | "config" | "data",
      | "translation"
      | "track"
      | "role"
      | "remoteDetectionAlert"
      | "projectSettings"
      | "preset"
      | "observation"
      | "icon"
      | "field"
      | "deviceInfo"
      | "coreOwnership">
- TTable extends MapeoDocTables
- TSchemaName extends
      | "translation"
      | "track"
      | "role"
      | "remoteDetectionAlert"
      | "projectSettings"
      | "preset"
      | "observation"
      | "icon"
      | "field"
      | "deviceInfo"
      | "coreOwnership"
- TDoc extends
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
- TValue extends
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
      | {
          schemaName: TSchemaName;
      } & {}
Parameters
- __namedParameters: {
      dataStore: TDataStore;
      db: BetterSQLite3Database<Record<string, never>>;
      getTranslations: ((value: {} & {
          docRef: {};
      }) => Promise<{}[]>);
      table: TTable;
  }
  - dataStore: TDataStore
  - db: BetterSQLite3Database<Record<string, never>>
  - getTranslations: ((value: {} & {
    docRef: {};
    }) => Promise<{}[]>)
    - (value): Promise<{}[]>
      Parameters
      value: {} & {
      docRef: {};
      }
      Returns Promise<{}[]>
  - table: TTable
Returns DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>
Overrides TypedEmitter<DataTypeEvents<TDoc>>.constructor

Accessors

[kDataStore]

get [kDataStore](): TDataStore
Returns TDataStore

[kTable]

get [kTable](): TTable
Returns TTable

namespace

get namespace(): namespace
Returns namespace

schemaName

get schemaName(): TSchemaName
Returns TSchemaName

Methods

[kCreateWithDocId]

[kCreateWithDocId](docId, value): Promise<TDoc & {
forks: string[];
}>
Parameters
- docId: string
- value: Exclude<TValue, {
  schemaName: "coreOwnership";
  }> | CoreOwnershipWithSignaturesValue
Returns Promise<TDoc & {
forks: string[];
}>

[kSelect]

[kSelect](): Promise<any>
Returns Promise<any>

create

create<T>(value): Promise<TDoc & {
forks: string[];
}>
Type Parameters
- T extends unknown
Parameters
- value: T
Returns Promise<TDoc & {
forks: string[];
}>

delete

delete(docId): Promise<TDoc & {
forks: string[];
}>
Parameters
- docId: string
Returns Promise<TDoc & {
forks: string[];
}>

getByDocId

getByDocId(docId, opts?): Promise<TDoc & {
forks: string[];
}>
Parameters
- docId: string
- Optionalopts: {
  lang?: string;
  mustBeFound?: true;
  }
  - Optionallang?: string
  - OptionalmustBeFound?: true
Returns Promise<TDoc & {
forks: string[];
}>
getByDocId(docId, opts?): Promise<null | TDoc & {
forks: string[];
}>
Parameters
- docId: string
- Optionalopts: {
  lang?: string;
  mustBeFound?: boolean;
  }
  - Optionallang?: string
  - OptionalmustBeFound?: boolean
Returns Promise<null | TDoc & {
forks: string[];
}>

getByVersionId

getByVersionId(versionId, opts?): Promise<TDoc>
Parameters
- versionId: string
- Optionalopts: {
  lang?: string;
  }
  - Optionallang?: string
Returns Promise<TDoc>

getMany

getMany(opts?): Promise<(TDoc & {
forks: string[];
})[]>
Parameters
- Optionalopts: {
  includeDeleted?: boolean;
  lang?: string;
  }
  - OptionalincludeDeleted?: boolean
  - Optionallang?: string
Returns Promise<(TDoc & {
forks: string[];
})[]>

update

update<T>(versionId, value): Promise<TDoc & {
forks: string[];
}>
Type Parameters
- T extends unknown
Parameters
- versionId: string | string[]
- value: T
Returns Promise<TDoc & {
forks: string[];
}>

Class DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>

Type Parameters

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

dataStore: TDataStore

db: BetterSQLite3Database<Record<string, never>>

getTranslations: ((value: {} & { docRef: {}; }) => Promise<{}[]>)

Parameters

Returns Promise<{}[]>

table: TTable

Returns DataType<TDataStore, TTable, TSchemaName, TDoc, TValue>

Accessors

[kDataStore]

Returns TDataStore

[kTable]

Returns TTable

namespace

Returns namespace

schemaName

Returns TSchemaName

Methods

[kCreateWithDocId]

Parameters

Returns Promise<TDoc & { forks: string[]; }>

[kSelect]

Returns Promise<any>

create

Type Parameters

Parameters

Returns Promise<TDoc & { forks: string[]; }>

delete

Parameters

Returns Promise<TDoc & { forks: string[]; }>

getByDocId

Parameters

Optionallang?: string

OptionalmustBeFound?: true

Returns Promise<TDoc & { forks: string[]; }>

Parameters

Optionallang?: string

OptionalmustBeFound?: boolean

Returns Promise<null | TDoc & { forks: string[]; }>

getByVersionId

Parameters

Optionallang?: string

Returns Promise<TDoc>

getMany

Parameters

OptionalincludeDeleted?: boolean

Optionallang?: string

Returns Promise<(TDoc & { forks: string[]; })[]>

update

Type Parameters

Parameters

Returns Promise<TDoc & { forks: string[]; }>

Settings

On This Page

getTranslations: ((value: {} & {
docRef: {};
}) => Promise<{}[]>)

Returns Promise<TDoc & {
forks: string[];
}>

Returns Promise<TDoc & {
forks: string[];
}>

Returns Promise<TDoc & {
forks: string[];
}>

`Optional`lang?: string

`Optional`mustBeFound?: true

Returns Promise<TDoc & {
forks: string[];
}>

`Optional`lang?: string

`Optional`mustBeFound?: boolean

Returns Promise<null | TDoc & {
forks: string[];
}>

`Optional`lang?: string

`Optional`includeDeleted?: boolean

`Optional`lang?: string

Returns Promise<(TDoc & {
forks: string[];
})[]>

Returns Promise<TDoc & {
forks: string[];
}>