[![logo][]](https://xyo.network)

# @xyo-network/typeof

[![npm][npm-badge]][npm-link]
[![license][license-badge]][license-link]

> Primary SDK for using XYO Protocol 2.0

## Install

Using npm:

```sh
npm install {{name}}
```

Using yarn:

```sh
yarn add {{name}}
```

Using pnpm:

```sh
pnpm add {{name}}
```

Using bun:

```sh
bun add {{name}}
```


## License

See the [LICENSE](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**](#../README)

***

```ts
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**](#../README)

***

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

## Type Parameters

### T

`T`

### R

`R`

## Parameters

### typeName

[`TypeOfTypes`](#../type-aliases/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**](#../README)

***

```ts
function typeOf<T>(item): TypeOfTypes;
```

## Type Parameters

### T

`T`

## Parameters

### item

`T`

## Returns

[`TypeOfTypes`](#../type-aliases/TypeOfTypes)

## Deprecated

use @xylabs/typeof or zod

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

[**@xyo-network/typeof**](#../README)

***

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

## Type Parameters

### T

`T`

## Parameters

### typeName

[`TypeOfTypes`](#../type-aliases/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**](#../README)

***

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

## Deprecated

use @xylabs/typeof or zod


[logo]: https://cdn.xy.company/img/brand/XYO_full_colored.png
[npm-badge]: https://img.shields.io/npm/v/@xyo-network/typeof.svg
[npm-link]: https://www.npmjs.com/package/@xyo-network/typeof
[license-badge]: https://img.shields.io/npm/l/@xyo-network/typeof.svg
[license-link]: https://github.com/xylabs/sdk-js/blob/main/LICENSE