IngestX

Installation

Install the IngestX library

Install the main package from npm using your preferred package manager.

pnpm add @izanagi-labs/ingestx
npm install @izanagi-labs/ingestx
yarn add @izanagi-labs/ingestx

Package Entry Points

IngestX is distributed as a single package with three distinct entry points for different environments:

  1. @izanagi-labs/ingestx The core ingestion logic and schema builder. Usable directly in modern browser environments.

  2. @izanagi-labs/ingestx/react The React adapter. Exposes the useIngest hook to deeply integrate IngestX with the React component lifecycle.

  3. @izanagi-labs/ingestx/node The Node.js adapter. Exposes a specialized ingest() function designed to read files from the filesystem efficiently using Node streams.

[!NOTE] All entry points are provided by the @izanagi-labs/ingestx package on npm. You do not need to install separate adapter packages.

Requirements

IngestX requires a modern runtime environment:

  • Browser: Modern browsers supporting Web Workers (for asynchronous processing).
  • Node.js: Version 18.0.0 or higher.
  • React: Version 18.0.0 or 19.0.0+ (if using the React adapter).

On this page