mirror of https://github.com/mountain-loop/yaak.git synced 2026-08-18 01:15:12 +02:00

Files

T

Gregory Schier 96c8a95094 Add a plugin API for reading HTTP response bodies

Plugins read bodies by response id through ctx.httpResponse.body()
instead of opening HttpResponse.bodyPath themselves. The accessors are
named after fetch's, minus the single-use semantics, since the bytes are
durable and re-reading should work.

Underneath is a chunked pull over the existing plugin protocol, so the
host can move bodies off the filesystem without plugins noticing.
text() now decodes with the response's charset rather than assuming
UTF-8, and the buffering accessors refuse past 32 MiB and point at
chunks().

2026-08-16 09:20:29 -07:00

src

Add a plugin API for reading HTTP response bodies

2026-08-16 09:20:29 -07:00

.gitignore

Move JS monorepo packages to folder

2025-01-04 16:55:18 -08:00

package.json

Add a plugin API for reading HTTP response bodies

2026-08-16 09:20:29 -07:00

README.md

Update feedback links

2026-01-14 06:45:45 -08:00

tsconfig.json

Fix gRPC Any response reflection (#451 )

2026-05-06 07:42:35 -07:00

README.md

Yaak Plugin API

Yaak is a desktop API client for interacting with REST, GraphQL, Server Sent Events (SSE), WebSocket, and gRPC APIs. It's built using Tauri, Rust, and ReactJS.

Plugins can be created in TypeScript, which are executed alongside Yaak in a NodeJS runtime. This package contains the TypeScript type definitions required to make building Yaak plugins a breeze.

Quick Start

The easiest way to get started is by generating a plugin with the Yaak CLI:

npx @yaakapp/cli generate

For more details on creating plugins, check out the Quick Start Guide

Installation

If you prefer starting from scratch, manually install the types package:

npm install -D @yaakapp/api