@xyo-network/shared

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

shared

### .temp-typedoc

  ### interfaces

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

@xyo-network/shared

Properties

name

name: string;

onComplete?

optional onComplete?: VoidFunction;

onFail?

optional onFail?: VoidFunction;

onStart?

optional onStart?: VoidFunction;

onSuccess?

optional onSuccess?: VoidFunction;

schedule

schedule: string;

task

task: Task;

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

@xyo-network/shared

Accessors

jobs

Get Signature

get jobs(): Job[];

Returns

Job[]

  ### type-aliases

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

@xyo-network/shared

type VoidFunction = (...anyArguments) => void;

Parameters

anyArguments

...unknown[]

Returns

void