Skip to content
On this page

Farfetched Dev Tools

WARNING

Currently, Farfetched Dev Tools is in technical preview, so it could have some bugs and lack of features. We are constantly working on it and will be happy to hear your feedback in issues.

To simplify debugging of your application, Farfetched provides a special tool — Farfetched Dev Tools. It is a browser application that allows you to see all Queries and its states.

DevTools UI

Farfetched Dev Tools is distributed as a separate package, so you need to install it first:

sh
pnpm install @farfetched/dev-tools
sh
yarn add @farfetched/dev-tools
sh
npm install @farfetched/dev-tools

Then just add it to your project:

ts
// main.ts

if (process.env.NODE_ENV === 'development') {
  const { attachFarfetchedDevTools } = await import('@farfetched/dev-tools');

  attachFarfetchedDevTools();
}

In case you are using Fork API, you need to pass Scope to attachFarfetchedDevTools:

ts
// main.ts
import { fork } from 'effector';

const scope = fork();

if (process.env.NODE_ENV === 'development') {
  const { attachFarfetchedDevTools } = await import('@farfetched/dev-tools');

  attachFarfetchedDevTools({ scope }); 
}

That is it, now you can open Farfetched Dev Tools in your browser and see all your Queries and its states.

Roadmap

TIP

You can submit a feature request in issues.

Since Farfetched Dev Tools is quite new, it has a lot of features to be implemented. Here is a list of the planned features:

Released under the MIT License.