@xyo-network/typeof

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

### packages

  ### typeof

    ### .temp-typedoc

      ### functions

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

@xyo-network/typeof

function ifDefined<T>(value, function_): T | undefined;

Type Parameters

T

T

Parameters

value

T

function_

(value) => void

Returns

T | undefined

Deprecated

use @xylabs/typeof or zod

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

@xyo-network/typeof

function ifTypeOf<T, R>(
   typeName, 
   value, 
   trueFunction, 
   isFunction?): R | undefined;

Type Parameters

T

T

R

R

Parameters

typeName

TypeOfTypes

value

unknown

trueFunction

(value) => R

isFunction?

(value) => boolean

Returns

R | undefined

Deprecated

use @xylabs/typeof or zod

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

@xyo-network/typeof

function typeOf<T>(item): TypeOfTypes;

Type Parameters

T

T

Parameters

item

T

Returns

TypeOfTypes

Deprecated

use @xylabs/typeof or zod

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

@xyo-network/typeof

function validateType<T>(
   typeName, 
   value, 
   optional?): [T | undefined, Error[]];

Type Parameters

T

T

Parameters

typeName

TypeOfTypes

value

T

optional?

boolean = false

Returns

[T | undefined, Error[]]

Deprecated

use @xylabs/typeof or zod

      ### type-aliases

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

@xyo-network/typeof

type TypeOfTypes = 
  | "string"
  | "number"
  | "object"
  | "array"
  | "buffer"
  | "null"
  | "undefined"
  | "bigint"
  | "boolean"
  | "function"
  | "symbol";

Deprecated

use @xylabs/typeof or zod