@xyo-network/diviner-indexing-model

Primary SDK for using XYO Protocol 2.0

Install

Using npm:

npm install {{name}}

Using yarn:

yarn add {{name}}

Using pnpm:

pnpm add {{name}}

Using bun:

bun add {{name}}

License

See the LICENSE file for license rights and limitations (LGPL-3.0-only).

Reference

packages

modules

### packages

  ### diviner

    ### packages

      ### indexing

        ### packages

          ### model

            ### .temp-typedoc

              ### type-aliases

                ### <a id="DivinerStageSchema"></a>DivinerStageSchema

@xyo-network/diviner-indexing-model

type DivinerStageSchema = typeof DivinerStageSchema;

                ### <a id="ImageThumbnailDivinerSchema"></a>ImageThumbnailDivinerSchema

@xyo-network/diviner-indexing-model

type ImageThumbnailDivinerSchema = typeof IndexingDivinerSchema;

                ### <a id="IndexingDivinerConfig"></a>IndexingDivinerConfig

@xyo-network/diviner-indexing-model

type IndexingDivinerConfig<TConfig, TSchema> = DivinerConfig<WithAdditional<{
  indexStore?: SearchableStorage;
  indexingDivinerStages?: IndexingDivinerStageConfig;
  payloadDivinerLimit?: number;
  pollFrequency?: number;
  schema: IndexingDivinerConfigSchema;
  stateStore?: SearchableStorage;
}, TConfig>, TSchema>;

Type Parameters

TConfig

TConfig extends Payload | EmptyObject | void = void

TSchema

TSchema extends Schema | void = void

                ### <a id="IndexingDivinerConfigSchema"></a>IndexingDivinerConfigSchema

@xyo-network/diviner-indexing-model

type IndexingDivinerConfigSchema = typeof IndexingDivinerConfigSchema;

                ### <a id="IndexingDivinerParams"></a>IndexingDivinerParams

@xyo-network/diviner-indexing-model

type IndexingDivinerParams = DivinerParams<AnyConfigSchema<IndexingDivinerConfig>>;

                ### <a id="IndexingDivinerStage"></a>IndexingDivinerStage

@xyo-network/diviner-indexing-model

type IndexingDivinerStage = 
  | "divinerQueryToIndexQueryDiviner"
  | "indexCandidateToIndexDiviner"
  | "indexQueryResponseToDivinerQueryResponseDiviner"
  | "stateToIndexCandidateDiviner";

The diviners for each stage of an indexing diviner

                ### <a id="IndexingDivinerStageConfig"></a>IndexingDivinerStageConfig

@xyo-network/diviner-indexing-model

type IndexingDivinerStageConfig = { [key in IndexingDivinerStage]: ModuleIdentifier };

Config section for declaring each indexing diviner stage

                ### <a id="IndexingDivinerStageLabels"></a>IndexingDivinerStageLabels

@xyo-network/diviner-indexing-model

type IndexingDivinerStageLabels = Labels & { [key in DivinerStageSchema]: IndexingDivinerStage };

Labels for Indexing Diviner Stage Diviners

                ### <a id="IndexingDivinerState"></a>IndexingDivinerState

@xyo-network/diviner-indexing-model

type IndexingDivinerState = StateDictionary & object;

Type Declaration

cursor

cursor: Sequence;

              ### variables

                ### <a id="DivinerStageSchema"></a>DivinerStageSchema

@xyo-network/diviner-indexing-model

const DivinerStageSchema: "network.xyo.diviner.stage" & object;

Type Declaration

__schema

readonly __schema: true;

                ### <a id="IndexingDivinerConfigSchema"></a>IndexingDivinerConfigSchema

@xyo-network/diviner-indexing-model

const IndexingDivinerConfigSchema: string & object;

Type Declaration

__schema

readonly __schema: true;

                ### <a id="IndexingDivinerSchema"></a>IndexingDivinerSchema

@xyo-network/diviner-indexing-model

const IndexingDivinerSchema: "network.xyo.diviner.indexing" & object;

Type Declaration

__schema

readonly __schema: true;