TypeScript client

The TypeScript client for Windmill allows you to interact with the Windmill platform using TypeScript in Bun / Deno runtime. This client provides a set of functions and utilities to access Windmill resources and perform various operations.

The TypeScript Windmill SDK can be found at https://app.windmill.dev/tsdocs/modules.html

TypeScript Windmill SDK

TypeScript SDK for Windmill

Installation

Within Windmill, the client is available out of the box: import windmill-client in a Bun script or npm:windmill-client in a Deno script. For local development, install Bun or Deno and the client is fetched from the npm registry.

TypeScript (Bun)

import * as wmill from 'windmill-client';

TypeScript (Deno)

import * as wmill from 'npm:windmill-client';

Usage

The TypeScript client provides several functions that you can use to interact with the Windmill platform. Here's an example of how to use the client to get a resource from Windmill:

TypeScript (Bun)

import * as wmill from 'windmill-client';

export async function main() {
	let x = await wmill.getResource('u/user/name');
}

TypeScript (Deno)

import * as wmill from 'npm:windmill-client';

export async function main() {
	let x = await wmill.getResource('u/user/name');
}

In the example above, the getResource function is used to retrieve a resource with the path 'u/user/name' from the Windmill platform. The returned resource can be further processed or used as needed in your application.