Skip to content

iWhatty/nanotypes

Repository files navigation

nanotypes

npm downloads bundle size license stars

Minimal, runtime-safe type guards for modern JavaScript. Two surfaces, same package: an ergonomic is namespace, plus per-guard named exports that tree-shake to ~600 bytes gzipped for a single guard. Zero dependencies.

Features

  • Runtime-safe typeof and instanceof matching
  • Dynamic support for global constructors (Map, URL, etc.)
  • Safe in Node, browsers, workers, and edge runtimes
  • Non-throwing instanceof checks (runtime hardened)
  • All guards return strict booleans (true | false)
  • Production-hardened: exported APIs are frozen in production
  • Shared DEV detection via globalThis.__DEV__ or NODE_ENV !== "production"
  • Auto-generated assertType.* versions
  • Primitive shorthands: is.str, is.num, is.bool, is.bigi, is.sym, is.undef
  • Structural-guard shorthands: is.objis.object, is.arris.array (added in 0.0.17)
  • Built-in TypeScript type predicates
  • No dependencies

Install

pnpm add nanotypes

Quick start

Two import styles, same package, choose by bundle-size sensitivity.

Per-guard named exports (recommended for size-sensitive bundles, tree-shakes to ~600 bytes gzipped for a single guard):

import { isString, isObject, assertString } from 'nanotypes';

if (isString("hello")) {
  console.log("It's a string!");
}

assertString(maybeText); // throws TypeError if not a string

Legacy is / assertType namespaces (ergonomic, pulls the full ~2.3 KB gzipped surface):

import { is, assertType, describe } from 'nanotypes';

if (is.string("hello")) console.log("It's a string!");
if (is.str("hello")) console.log("Short and sweet.");
if (is(someValue, HTMLElement)) someValue.focus();

assertType.promise(Promise.resolve()); // throws TypeError if invalid

console.log(describe.value(new Map())); // "Map"

Both shapes are kept in lockstep. Every guard isFoo named export has a matching is.foo on the namespace; every assert assertFoo has a matching assertType.foo.


API

Generic matcher

is(value, Class)
  • Uses instanceof internally
  • Logs warnings in development (globalThis.__DEV__ = true or when process.env.NODE_ENV !== "production")
  • Never throws, safely returns false on invalid constructor input

Type-specific guards

Guards are generated dynamically from available runtime constructors. Some guards may only exist when the constructor exists in that environment (e.g., DOM-related guards in browsers but not in Node).

Guard Description
is.string(x) / is.str(x) typeof x === "string"
is.number(x) / is.num(x) typeof x === "number" (includes NaN)
is.numberSafe(x) Number and not NaN
is.boolean(x) / is.bool(x) Boolean primitive
is.bigint(x) / is.bigi(x) BigInt primitive
is.symbol(x) / is.sym(x) Symbol primitive
is.undefined(x) / is.undef(x) Strictly undefined
is.defined(x) Not null or undefined
is.nullish(x) null or undefined
is.nil(x) Strictly null
is.array(x) / is.arr(x) Array literal check
is.object(x) / is.obj(x) Non-null object, not array
is.objectStrict(x) Exactly a {} object
is.plainObject(x) Object with prototype Object or null
is.func(x) Function check
is.map(x) Instance of Map
is.date(x) Instance of Date
is.error(x) Instance of Error
is.textNode(x) DOM Text node (browser only)
is.htmlElement(x) HTMLElement node (browser only)
is.contentEditable(x) Editable DOM node
is.positiveNumber(x) Greater than 0
is.negativeNumber(x) Less than 0
is.integer(x) Whole number
is.finite(x) Not Infinity, not NaN
is.truthy(x) Narrowed to non-falsy value
is.falsy(x) Falsy value

Note: is.number(x) follows standard JavaScript semantics and returns true for NaN. Use is.numberSafe(x) if you require a numeric value that is not NaN.

Assertive guards

All is.* functions have an assertType.* equivalent:

assertType.url(x) // throws TypeError if not a URL

Use guards for conditional logic. Use asserts when invalid input should immediately fail.


Notes

Why nanotypes?

JavaScript type checks are deceptively inconsistent:

  • typeof null === "object"
  • Array.isArray(x) is required for arrays
  • instanceof can throw in exotic or cross-realm scenarios
  • Browser globals like HTMLElement don't exist in Node
  • Guards scattered across codebases lead to inconsistency

nanotypes centralizes and hardens these checks into a small, predictable surface.

TypeScript vs runtime checks

TypeScript is compile-time. nanotypes is runtime. They solve different problems.

What TypeScript does well:

  • Prevents incorrect usage during development
  • Provides IDE autocomplete and static analysis
  • Catches type mismatches before build

What TypeScript cannot guarantee:

At runtime, TypeScript types disappear. Values coming from API responses, JSON.parse, user input, localStorage, environment variables, or third-party libraries may not match their declared types. nanotypes validates those values at runtime.

They work together. nanotypes guards are typed as proper type predicates:

if (is.string(x)) {
  // x is now narrowed to string
}

assertType.numberSafe(x);
// x is guaranteed to be a non-NaN number here

This means IDEs narrow types correctly, fewer as casts, fewer @ts-ignore comments, safer boundary validation.

TypeScript tells you what should be true. nanotypes checks what is true.

Runtime safety

nanotypes is hardened for modern environments:

  • Safe access of globalThis constructors
  • No crashes from missing browser globals (e.g., HTMLElement in Node)
  • Defensive instanceof handling
  • Works consistently across Node, browsers, workers, and edge runtimes
  • Guards never throw, they return false
  • Assertions throw clean TypeError messages with readable descriptions

Runtime-adaptive behavior

The default entry ships a curated static map of well-known constructors. Each guard is feature-detected at module load, so browser-only constructors (like HTMLElement) will not exist when you import { is } from Node.

If writing universal libraries, defensive-check before calling:

if (typeof is.htmlElement === 'function' && is.htmlElement(node)) {
  // browser-only logic
}

Auto-discovery via nanotypes/auto

If you need guards for globals beyond the curated set (urlPattern, broadcastChannel, compressionStream, custom platform APIs, user-defined globals), import the /auto subpath:

import { is, assertType } from 'nanotypes/auto';

/auto walks globalThis at module load and adds every constructor-shaped global to the is namespace, on top of the curated static set. Trade-off: a larger surface that TypeScript can't narrow against (the .d.ts for /auto is the same as the default; the extra guards are reachable but un-narrowed). About ~370 bytes larger gzipped than the default. Useful for diagnostic or introspective code; not recommended as a default import in size-sensitive bundles.

Migration from 0.0.x / 0.1.0

  • 0.0.x → 0.1.0: the default entry no longer runs the global scanner at import; the scanner is opt-in via /auto. If you were relying on a guard for an exotic global like is.urlPattern, switch the import line to 'nanotypes/auto'.
  • 0.1.0 → 0.2.0: purely additive. New per-guard named exports (isString, assertString, etc.) join the existing is / assertType namespaces; both shapes work side by side. Recommended pattern for size-sensitive bundles is to migrate import { is } from 'nanotypes'; is.string(x) to import { isString } from 'nanotypes'; isString(x), which saves ~1 KB gzipped per import when only a few guards are used.

Design principles

  • Guards never throw
  • Asserts throw intentionally (TypeError)
  • No runtime assumptions
  • Safe reflection on globalThis
  • Runtime-adaptive constructor support
  • Tree-shakable ESM surface
  • Zero dependencies
  • Immutable public API in production

When not to use nanotypes

nanotypes may not be necessary if:

  • You use strict TypeScript and never validate unknown runtime input.
  • You only need one or two inline type checks.
  • You are already using a schema validation library (e.g., Zod, Valibot, Yup).

nanotypes is designed as a lightweight guard layer, not a schema system.

Philosophy

Make JavaScript safer without making it heavier. nanotypes avoids boilerplate and unnecessary runtime bloat. Just clean, modern type guards ready for anything from browser UIs to CLI tools.


License

Licensed under AGPL-3.0 with WATT3D Additional Terms. See LICENSE and ADDITIONAL_TERMS.md. Commercial AI/model-training use requires compliance with those terms or a separate WATT3D license. © WATT3D.

About

Minimal, runtime-safe type guards for modern JavaScript.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors