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

      ### transform

        ### packages

          ### model

            ### .temp-typedoc

              ### functions

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

@xyo-network/diviner-transform-model

function isTransformDivinerQueryPayload(x?): x is TransformDivinerQueryPayload;

Parameters

x?

Payload | null

Returns

x is TransformDivinerQueryPayload

              ### interfaces

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

@xyo-network/diviner-transform-model

Properties

transformMethod?

optional transformMethod?: string;

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

@xyo-network/diviner-transform-model

Properties

jsonPathExpression?

optional jsonPathExpression?: string;

              ### type-aliases

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

@xyo-network/diviner-transform-model

type PayloadTransformer<TSource, TDestination> = (payload) => TDestination;

Type Parameters

TSource

TSource extends Payload = Payload

TDestination

TDestination extends Payload = Payload

Parameters

payload

TSource

Returns

TDestination

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

@xyo-network/diviner-transform-model

type PayloadValueTransformer<TSource> = (payload) => JsonValue;

Type Parameters

TSource

TSource extends Payload = Payload

Parameters

payload

TSource

Returns

JsonValue

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

@xyo-network/diviner-transform-model

type Transform = Payload<{
  transform: TransformDictionary;
}, TransformDivinerSchema>;

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

@xyo-network/diviner-transform-model

type TransformDictionary = object;

Index Signature

[key: string]: string

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

@xyo-network/diviner-transform-model

type TransformDivinerConfig = DivinerConfig<object & object>;

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

@xyo-network/diviner-transform-model

type TransformDivinerConfigSchema = typeof TransformDivinerConfigSchema;

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

@xyo-network/diviner-transform-model

type TransformDivinerQueryPayload = Query<object & Partial<TransformSettings>>;

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

@xyo-network/diviner-transform-model

type TransformDivinerQuerySchema = typeof TransformDivinerQuerySchema;

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

@xyo-network/diviner-transform-model

type TransformDivinerSchema = typeof TransformDivinerSchema;

              ### variables

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

@xyo-network/diviner-transform-model

const TransformDivinerConfigSchema: string & object;

Type Declaration

__schema

readonly __schema: true;

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

@xyo-network/diviner-transform-model

const TransformDivinerQuerySchema: string & object;

Type Declaration

__schema

readonly __schema: true;

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

@xyo-network/diviner-transform-model

const TransformDivinerSchema: "network.xyo.diviner.transform" & object;

Type Declaration

__schema

readonly __schema: true;