Installation

Install

WELD requires zod as a peer dependency for runtime validation.

npm

npm install @weldjs/http zod

pnpm

pnpm add @weldjs/http zod

yarn

yarn add @weldjs/http zod

bun

bun add @weldjs/http zod

React — UI components + hooks

Install @weldjs/react for the full component library (Weld.Shell, Weld.Button, Weld.Table, etc.) and the useWeld hook.

npm install @weldjs/react zod

import { Weld, WeldProvider, useWeld } from '@weldjs/react'

Requires react >= 18 as a peer dependency.

Framework Adapters (HTTP only)

If you only need the HTTP client without the UI components, use the subpath adapters:

React (hook only)

import { useWeld } from '@weldjs/http/react'

Requires react >= 18 as a peer dependency.

Vue

import { useWeld } from '@weldjs/http/vue'

Requires vue >= 3.3 as a peer dependency.

SolidJS

import { useWeld } from '@weldjs/http/solid'

Requires solid-js >= 1.8 as a peer dependency.

Angular

import { toObservable } from '@weldjs/http/angular'

Requires rxjs >= 7 as a peer dependency.

Requirements

Runtime	Minimum version
Node.js	18+
Bun	1.0+
Deno	1.30+
Browser	Any modern browser with fetch and IndexedDB

TypeScript

WELD ships its own types — no @types/ package needed.

Recommended tsconfig.json settings:

{
  "compilerOptions": {
    "strict": true,
    "moduleResolution": "bundler"
  }
}

Quick scaffold

The fastest way to start is with the scaffold tool:

npm create weld-app@latest my-app
cd my-app
npm run dev

This sets up a full project with @weldjs/react, Vite, and TypeScript configured.