Skip to main content
The Narrative TypeScript SDK (@narrative.io/data-collaboration-sdk-ts) provides type-safe access to the Narrative API for Node.js and TypeScript applications.

Installation

Quick start

Architecture

The SDK uses a mixin pattern to combine multiple API modules into a single NarrativeApi class. This provides a unified interface while maintaining type safety for each module’s methods.

Available API modules

The SDK provides access to the following API modules: For complete method signatures and parameters, see API Modules Reference.

Requirements

  • Node.js: 18 or later
  • TypeScript: 4.7 or later (for TypeScript users)

Source and issues

Configuration

Configuration options and environments

API Modules

Complete method reference

SDK Quickstart

Get started with the SDK

SDK Guides

How-to guides for common tasks