tinylicious

library7.0.1jsnpmunverified

Tinylicious is a minimal, in-memory reference implementation of the Fluid Framework routerlicious service, intended for local development, testing, and debugging. Version 7.0.1 targets Node >=14 and ships TypeScript types. It provides a lightweight alternative to running a full Azure Fluid Relay or Routerlicious server, with no external dependencies beyond Node.js. Ideal for developers building Fluid Framework applications who need a quick local server without cloud infrastructure. Note that Tinylicious is not production-ready and lacks persistence, scaling, or security features.

testing

npm install tinylicious

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · TINYLICIOUS

tinylicious

testingjavascriptv7.0.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

TinyliciousServer

✓ import { TinyliciousServer } from 'tinylicious';

✗ const TinyliciousServer = require('tinylicious');

This package is ESM-only starting from v2.

ITestFluidDataStore

✓ import type { ITestFluidDataStore } from 'tinylicious';

✗ import { ITestFluidDataStore } from 'tinylicious';

ITestFluidDataStore is a type; use import type for better tree-shaking and ESM compatibility.

TinyliciousClient

✓ import { TinyliciousClient } from 'tinylicious';

✗ import TinyliciousClient from 'tinylicious';

TinyliciousClient is a named export, not the default export (there is no default export).

Starts a local Tinylicious server on the specified port (default 7070) using ESM imports.

import { TinyliciousServer } from 'tinylicious'; const server = new TinyliciousServer({ port: parseInt(process.env.PORT ?? '7070'), }); await server.start(); console.log(`Tinylicious server running on port ${server.port}`); // stop the server later if needed: // await server.close();

Debug

Known issues

gotchaTinylicious stores all data in memory; restarting the server loses all state.

fix

Use Tinylicious only for development/testing. For persistent storage, use Azure Fluid Relay or customize Routerlicious.

affects: >=1.0.0

breakingIn version 2.0.0, Tinylicious switched from CommonJS to ESM only. require() usage will fail.

fix

Use import syntax or update to ESM-compatible code. Add "type": "module" to package.json if using Node <16.

affects: >=2.0.0

breakingIn version 7.0.0, TinyliciousServer constructor signature changed: options object now requires explicit port as number.

fix

When constructing TinyliciousServer, pass an object with `port: number` (not a string or nested object).

affects: >=7.0.0

gotchaTinylicious is not intended for production; it lacks authentication, authorization, and persistence.

fix

Always use a production-grade service (Azure Fluid Relay or Routerlicious) for production applications.

affects: >=1.0.0

deprecatedITestFluidDataStore type is deprecated and will be removed in v8. Use a custom Fluid object or FluidClient instead.

fix

Replace ITestFluidDataStore with your own data store type using Fluid Framework's DataObject pattern.

affects: >=7.0.0

Errors

Common errors & fixes

Error [ERR_REQUIRE_ESM]: require() of ES Module 'tinylicious' from ... not supported.

Older version using require() but Tinylicious >=2.0.0 is ESM-only.

fix

Use import statement (ESM) or downgrade to tinylicious@1.x. If using Node <14, upgrade Node and add "type": "module" to package.json.

TypeError: TinyliciousServer is not a constructor

Importing TinyliciousServer incorrectly, possibly as a default import or with require().

fix

Use named import: import { TinyliciousServer } from 'tinylicious';

Failed to start Tinylicious: listen EADDRINUSE :::7070

Port 7070 is already in use by another process.

fix

Kill the process on port 7070 or set a different port via environment variable (PORT).

Cannot find module 'tinylicious' or its corresponding type declarations.

Package not installed or TypeScript not configured to resolve node modules properly.

fix

Run npm install tinylicious@latest. Ensure tsconfig.json has "moduleResolution": "node" or "node16" and "esModuleInterop": true.

Upgrade

Version history

7.0.1latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

6 hits · last 30 days

node

Resources

githubhttps://github.com/microsoft/FluidFramework ↗

packagetinylicious ↗

homepagehttps://fluidframework.com ↗