Installation
Install the IngestX library
Install the main package from npm using your preferred package manager.
pnpm add @izanagi-labs/ingestxnpm install @izanagi-labs/ingestxyarn add @izanagi-labs/ingestxPackage Entry Points
IngestX is distributed as a single package with three distinct entry points for different environments:
-
@izanagi-labs/ingestxThe core ingestion logic and schema builder. Usable directly in modern browser environments. -
@izanagi-labs/ingestx/reactThe React adapter. Exposes theuseIngesthook to deeply integrate IngestX with the React component lifecycle. -
@izanagi-labs/ingestx/nodeThe Node.js adapter. Exposes a specializedingest()function designed to read files from the filesystem efficiently using Node streams.
[!NOTE] All entry points are provided by the
@izanagi-labs/ingestxpackage 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).