@xyo-network/config-payload-plugin

Typescript/Javascript Plugins for XYO Platform

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

core-payload-plugins

### packages

  ### config

    ### .temp-typedoc

      ### functions

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

@xyo-network/config-payload-plugin

function ConfigPayloadPlugin(): PayloadPlugin<Payload<{
  config: string;
  schema: "network.xyo.config" & object;
}>>;

Returns

PayloadPlugin<Payload<{ config: string; schema: "network.xyo.config" & object; }>>

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

@xyo-network/config-payload-plugin

function configPayloadTemplate(): Payload;

Returns

Payload

      ### type-aliases

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

@xyo-network/config-payload-plugin

type ConfigPayload<T> = WithAdditional<Payload<{
  config: string;
  schema: ConfigSchema;
}>, T>;

Type Parameters

T

T extends AnyObject | undefined = undefined

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

@xyo-network/config-payload-plugin

type ConfigSchema = typeof ConfigSchema;

      ### variables

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

@xyo-network/config-payload-plugin

const ConfigSchema: "network.xyo.config" & object;

Type Declaration

__schema

readonly __schema: true;