@xyo-network/diviner-jsonpath-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

      ### jsonpath

        ### packages

          ### model

            ### .temp-typedoc

              ### interfaces

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

@xyo-network/diviner-jsonpath-model

Describes the JSON-path transformation to retrieve a field on a source object and the target field to store the value to on a destination object

Properties

defaultValue?

optional defaultValue?: unknown;

The default value to use if the source field does not exist

destinationField

destinationField: string;

The target field to store the source field into on the destination object

sourcePathExpression

sourcePathExpression: string;

The JSON path expressions for the source field on the source object

              ### type-aliases

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

@xyo-network/diviner-jsonpath-model

type JsonPathDivinerConfig = DivinerConfig<object & object>;

The configuration for the JSON Path diviner

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

@xyo-network/diviner-jsonpath-model

type JsonPathDivinerConfigSchema = typeof JsonPathDivinerConfigSchema;

The config schema type for the JSON Path diviner

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

@xyo-network/diviner-jsonpath-model

type JsonPathDivinerParams = DivinerParams<AnyConfigSchema<JsonPathDivinerConfig>>;

The params type the JSON Path diviner

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

@xyo-network/diviner-jsonpath-model

type JsonPathDivinerSchema = typeof JsonPathDivinerSchema;

The schema type used for the JSONPath Diviner.

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

@xyo-network/diviner-jsonpath-model

type PayloadTransformer = (x) => Partial<Payload>;

Parameters

x

Payload

Returns

Partial<Payload>

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

@xyo-network/diviner-jsonpath-model

type SchemaToJsonPathTransformExpressionsDictionary<T> = { [key in keyof T]: JsonPathTransformExpression[] };

A dictionary of schema to JSON Path transform expressions.

Type Parameters

T

T extends object = { [schema: Schema]: unknown; }

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

@xyo-network/diviner-jsonpath-model

type SchemaToPayloadTransformersDictionary = object;

A dictionary of schema to payload transformers

Index Signature

[schema: string]: PayloadTransformer[]

              ### variables

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

@xyo-network/diviner-jsonpath-model

const JsonPathDivinerConfigSchema: string & object;

The config schema for the JSON Path diviner

Type Declaration

__schema

readonly __schema: true;

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

@xyo-network/diviner-jsonpath-model

const JsonPathDivinerSchema: "network.xyo.diviner.jsonpath" & object;

The schema used for the JSONPath Diviner.

Type Declaration

__schema

readonly __schema: true;