I/O service for Node.js.

The most common use of the I/O service is to read/write a Document with a given path. Methods are also available for converting in-memory representations of raw glTF files, both binary (ArrayBuffer) and JSON (JSONDocument).

Usage:

const fs = require('fs');
const path = require('path');
const { NodeIO } = require('@gltf-transform/core');

const io = new NodeIO();

// Read.
io.read('model.glb');             // → Document
io.readBinary(ArrayBuffer);       // → Document

// Write.
io.write('model.glb', doc); // → void
io.writeBinary(doc);        // → ArrayBuffer

Hierarchy

Constructors

  • Constructs a new NodeIO service. Instances are reusable.

Methods

  • readBinary(glb: ArrayBuffer): Document
  • registerDependencies(dependencies: {}): this
  • Registers dependencies used (e.g. by extensions) in the I/O process.

  • registerExtensions(extensions: typeof Extension[]): this
  • Registers extensions, enabling I/O class to read and write glTF assets requiring them.

  • setLogger(logger: Logger): this
  • write(uri: string, doc: Document): void
  • writeBinary(doc: Document): ArrayBuffer
Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.

Made by Don McCurdy TypeDoc documentation Copyright 2020 under MIT license