# @interopio/workspaces-api

> IOConnect Workspaces API

Latest version **5.0.0** (published 2026-10-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install @interopio/workspaces-api
pnpm add @interopio/workspaces-api
yarn add @interopio/workspaces-api
bun add @interopio/workspaces-api
```

## Health

**Score 70/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; recently updated; high maintenance score; high quality score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 5.0.0 |
| Published | 2026-10-05 |
| First published | 2023-09-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Interop.IO |
| Maintainers | smateev, tsachev, thorsent, hristo-kolev-interopio, ppetkow, gdavidkov, flashd2n, staafl, andy.gardner, kiril.popov, mitk0936, istoykov, danail.dobrev, trendo7 |
| Keywords | glue, glue42, desktop, workspaces, interop.io, io.connect browser, io.connect desktop |

## Links

- npm: https://www.npmjs.com/package/@interopio/workspaces-api
- Homepage: https://interop.io/
- npm.io page: https://npm.io/package/@interopio/workspaces-api

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 5.0.0 (latest) — 2026-10-05
- 5.0.0-next.0 (next) — 2026-09-09
- 4.1.1-beta.0 (beta) — 2025-09-11
- 3.3.5 (cb-3.3-lts) — 2024-09-04
- 3.2.3 (3.2-lts) — 2024-06-12
- 3.1.1 (3.1-lts) — 2024-03-05
- 3.0.4 (3.0-lts) — 2023-11-02
- 4.6.0 — 2026-08-21
- 4.5.0 — 2026-06-17
- 4.5.0-next.1 — 2026-06-03
- 4.4.0 — 2026-04-29
- 4.3.0 — 2026-04-02
- 4.2.8-next.0 — 2026-03-17
- 4.2.4 — 2026-03-16
- 4.2.3 — 2026-02-16
- … 40 more at https://npm.io/package/@interopio/workspaces-api/versions

## README

# @interopio/workspaces-api

## Overview

The [`@interopio/workspaces-api`](https://www.npmjs.com/package/@interopio/workspaces-api) library provides an API for managing Workspaces in **io.Connect Desktop** and **io.Connect Browser** projects.

## Installation

To install the library, execute the following command:

```cmd
npm install @interopio/workspaces-api
```

## Usage

The following examples demonstrate basic initialization of the `@interopio/workspaces-api` library in **io.Connect Desktop** and **io.Connect Browser** projects.

> ℹ️ *For more details on using the `@interopio/workspaces-api` library in **io.Connect Desktop** projects, see the **io.Connect Desktop** [official documentation](https://docs.interop.io/desktop/capabilities/windows/workspaces/overview/index.html).*

> ℹ️ *For more details on using the `@interopio/workspaces-api` library in **io.Connect Browser** projects, see the **io.Connect Browser** [official documentation](https://docs.interop.io/browser/capabilities/windows/workspaces/overview/index.html).*

### io.Connect Desktop

Initializing the `@interopio/workspaces-api` library in a client app of an **io.Connect Desktop** project:

```javascript
import IODesktop from "@interopio/desktop";
import IOWorkspaces from "@interopio/workspaces-api";

const config = {
    libraries: [IOWorkspaces]
};

const io = await IODesktop(config);

// Now you can access the Workspaces API via `io.workspaces`.
```

### io.Connect Browser

Initializing the `@interopio/workspaces-api` library in the Main app of an **io.Connect Browser** project:

```javascript
import IOBrowserPlatform from "@interopio/browser-platform";
import IOWorkspaces from "@interopio/workspaces-api";

const config = {
    licenseKey: "my-license-key",
    workspaces: {
        // Location of the Workspaces App.
        src: "https://my-workspaces-app.com"
    },
    browser: {
        // Initializing the Workspaces API.
        libraries: [IOWorkspaces]
    },
    layouts: {
        mode: "session",
        // Layout definition objects of type `"Workspace"`.
        local: [ {...}, {...}]
    }
};

const { io } = await IOBrowserPlatform(config);
```

Initializing the `@interopio/workspaces-api` library in a Browser Client app of an **io.Connect Browser** project:

```javascript
import IOBrowser from "@interopio/browser";
import IOWorkspaces from "@interopio/workspaces-api";

const config = {
    libraries: [IOWorkspaces]
};

const io = await IOBrowser(config);

// Now you can access the Workspaces API via `io.workspaces`.
```

---
_Source: https://npm.io/package/@interopio/workspaces-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._