⇔ undio

⇔ Conventionally and safely convert between various JavaScript data types.

✅ Features

Type-safe usage
Runtime-type safety assertion
Auto type detection and conversion
Tree-shakable and compact build
Leverage runtime native performance (+Bun stream utils)

👍 Supported Types

Usage

Install package:

# ✨ Auto-detect
npx nypm install undio

# npm
npm install undio

# yarn
yarn add undio

# pnpm
pnpm install undio

# bun
bun install undio

# deno
deno install undio

Import:

ESM (Node.js, Bun, Deno)

import {} from "undio";

CommonJS (Legacy Node.js)

const {} = require("undio");

CDN (Deno, Bun and Browsers)

import {} from "https://esm.sh/undio";

Auto Convert

Undio automatically detects the input type and uses the proper method to convert it to the expected type.

Example:

import { detectType, toText, toReadableStream } from "undio";

// Convert any supported type (auto-detected)
const string = await toText(value);
const stream = await toReadableStream(value);

// "ArrayBuffer" | "Blob"| "DataView" | "NumberArray" | "ReadableStream" | "String" | "Uint8Array";
const type = detectType(value);

Note

Because of stream support, the return type can be a promise. Always make sure to use an await before them.

Note

Alternatively you can use low-level *To*(value) utils to explicitly convert from one type to another. See all utils section.

Runtime type checking

You can use is*(input) and assert*(input) utils to validate input type.

Note

All conversion utilities use assertions for runtime type safety by default, so you don't need to manually do this.

Example:

import { isReadableStream, assertArrayBuffer } from "undio";

if (isReadableStream(value)) {
  /* do something */
}

assertArrayBuffer(value); // Throws an error if value is not ArrayBuffer
// do something