Getting Started

Build Aspose.3D FOSS for TypeScript from source. This section walks you through the prerequisites, installation, and a minimal first program that proves the library is working correctly in your environment.

Prerequisites

Before installing the package, ensure your environment meets the following requirements:

Node.js: The library targets CommonJS output and relies on built-in Node.js APIs (fs, Buffer, path). Any of Node.js 18, 20, or 22 is supported. Older versions (16 and below) are not supported. Download Node.js from nodejs.org.

TypeScript: The library is authored with strict compiler settings (noImplicitAny, strictNullChecks). TypeScript 5.0 or later is required for full type-checking compatibility. Install it locally in your project as a dev dependency.

A Node.js package manager: Either yarn or the manager bundled with Node.js works. The examples in this guide use its default install syntax; substitute the yarn equivalent if you prefer.

Installing the Package

See the Installation guide for the complete setup walkthrough, including:

• Building @aspose/3d from source
• Configuring tsconfig.json for compatibility
• Verifying the installation with a quick import test
• A complete quick-start script that loads a scene and prints node information
• Notes on the single transitive dependency (xmldom)

Available Topics

• Installation: Step-by-step setup guide with TypeScript configuration and a verified quick-start example.

See Also

• Aspose.3D for TypeScript — Enterprise Documentation