mirror of
https://github.com/mountain-loop/yaak.git
synced 2026-08-17 17:12:13 +02:00
Gregory Schier
0e14625e62
Holding an unsaved body against its response id let a plugin stash the id and read it in a later call, which would throw only sometimes and only for ad-hoc sends. Documenting that was never going to be enough. send now returns the response and its body together, so there is nothing to stash: an unsaved body is a value you were handed. ctx.httpResponse .body() goes back to meaning one thing, a saved response read by id, and refuses ids it has no row for. Reading is identical either way, so no caller has to know which kind of send it made.
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