Skip to content
Shoal
Shoal
You’re reading the docs for an older version. v1.xGo to the latest docs →

Getting started

Quickstart

Install shoal-js and evaluate a toggle.

  1. Install

    Terminal
    npm install shoal-js@1
    Terminal
    pnpm add shoal-js@1
    Terminal
    yarn add shoal-js@1
    Terminal
    bun add shoal-js@1
  2. Create a client

    shoal.js
    const Shoal = require("shoal-js");
    module.exports = new Shoal(process.env.SHOAL_KEY, { refresh: 60 });
  3. Check a toggle

    JavaScript
    const client = require("./shoal");
    const on = await client.enabled("new-checkout", { id: req.user.id });
Was this page helpful?

Type to search. Results come from a local index — nothing leaves your browser.

↑ ↓ to navigate↵ to openMiniSearch · local