Class DataStore<TNamespace, TSchemaName>

Type Parameters

Hierarchy

  • TypedEmitter
    • DataStore

Constructors

constructor

Accessors

indexer namespace schemas writerCore

Methods

close getIndexState read readRaw unlink write writeRaw

Constructors

constructor

  • new DataStore<TNamespace, TSchemaName>(opts): DataStore<TNamespace, TSchemaName>

  • Type Parameters

    • TNamespace extends "auth" | "config" | "data" = "auth" | "config" | "data"
    • TSchemaName extends
          | "observation"
          | "track"
          | "translation"
          | "preset"
          | "field"
          | "projectSettings"
          | "deviceInfo"
          | "icon"
          | "coreOwnership"
          | "role" = {
          auth: readonly ["coreOwnership", "role"];
          config: readonly ["translation", "preset", "field", "projectSettings", "deviceInfo", "icon"];
          data: readonly ["observation", "track"];
      }[TNamespace][number]

    Parameters

    Returns DataStore<TNamespace, TSchemaName>

Accessors

indexer

  • get indexer(): MultiCoreIndexer<"binary">

  • Returns MultiCoreIndexer<"binary">

namespace

schemas

  • get schemas(): ("observation" | "track")[] | (
        | "translation"
        | "preset"
        | "field"
        | "projectSettings"
        | "deviceInfo"
        | "icon")[] | ("coreOwnership" | "role")[]

  • Returns ("observation" | "track")[] | (
        | "translation"
        | "preset"
        | "field"
        | "projectSettings"
        | "deviceInfo"
        | "icon")[] | ("coreOwnership" | "role")[]

writerCore

Methods

close

  • close(): Promise<void>

  • Returns Promise<void>

getIndexState

  • getIndexState(): IndexState

  • Returns IndexState

read

  • read(versionId): Promise<MapeoDoc>

  • Parameters

    • versionId: string

    Returns Promise<MapeoDoc>

readRaw

  • readRaw(versionId): Promise<Buffer>

  • Parameters

    • versionId: string

    Returns Promise<Buffer>

unlink

  • unlink(): Promise<void>

  • Unlink all index files. This should only be called after close() has resolved.

    Returns Promise<void>

write

  • write<TDoc>(doc): Promise<
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>>

  • UNSAFE: Does not check links: [] refer to a valid doc - should only be used internally.

    Write a doc, must be one of the schema types supported by the namespace of this DataStore.

    Type Parameters

    • TDoc extends
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{} & CoreOwnershipSignatures, "versionId" | "originalVersionId" | "links"> & {}
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{}, "versionId">
          | {
              schemaName: TSchemaName;
          } & Omit<{} & CoreOwnershipSignatures, "versionId">

    Parameters

    Returns Promise<
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>
        | Extract<{}, TDoc>>

writeRaw

  • writeRaw(buf): Promise<string>

  • Parameters

    • buf: Buffer

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods