WebIO

I/O service for Web.

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 (Uint8Array) and JSON (JSONDocument).

Usage:

import { WebIO } from '@gltf-transform/core';

const io = new WebIO({credentials: 'include'});

// Read.
let document;
document = await io.read('model.glb');  // → Document
document = await io.readBinary(glb);    // Uint8Array → Document

// Write.
const glb = await io.writeBinary(document); // Document → Uint8Array

Hierarchy

PlatformIO
- WebIO

Constructors

new WebIO(fetchConfig?: RequestInit): WebIO

Constructs a new WebIO service. Instances are reusable.
Overrides PlatformIO.constructor
- Defined in packages/core/src/io/web-io.ts:33

Methods

binaryToJSON(glb: Uint8Array): Promise<JSONDocument>

Converts a GLB-formatted Uint8Array to a JSONDocument.
- Defined in packages/core/src/io/platform-io.ts:110

read(uri: string): Promise<Document>

Reads a Document from the given URI.
- Defined in packages/core/src/io/platform-io.ts:88

readAsJSON(uri: string): Promise<JSONDocument>

Loads a URI and returns a JSONDocument struct, without parsing.
- Defined in packages/core/src/io/platform-io.ts:93

readBinary(glb: Uint8Array): Promise<Document>

Converts a GLB-formatted Uint8Array to a Document.
- Defined in packages/core/src/io/platform-io.ts:126

readJSON(jsonDoc: JSONDocument): Promise<Document>

Converts glTF-formatted JSON and a resource map to a Document.
- Defined in packages/core/src/io/platform-io.ts:99

readURI(uri: string, type: "view"): Promise<Uint8Array>
readURI(uri: string, type: "text"): Promise<string>

Abstract.
Overrides PlatformIO.readURI
- Defined in packages/core/src/io/web-io.ts:44
Overrides PlatformIO.readURI
- Defined in packages/core/src/io/web-io.ts:45

registerDependencies(dependencies: {}): WebIO

Registers dependencies used (e.g. by extensions) in the I/O process.
- Defined in packages/core/src/io/platform-io.ts:58

registerExtensions(extensions: typeof Extension[]): WebIO

Registers extensions, enabling I/O class to read and write glTF assets requiring them.
- Defined in packages/core/src/io/platform-io.ts:49

setLogger(logger: ILogger): WebIO

Sets the Logger used by this I/O instance. Defaults to Logger.DEFAULT_INSTANCE.
- Defined in packages/core/src/io/platform-io.ts:43

setVertexLayout(layout: VertexLayout): WebIO

Sets the vertex layout method used by this I/O instance. Defaults to VertexLayout.INTERLEAVED.
- Defined in packages/core/src/io/platform-io.ts:67

writeBinary(doc: Document): Promise<Uint8Array>

Converts a Document to a GLB-formatted Uint8Array.
- Defined in packages/core/src/io/platform-io.ts:150

writeJSON(doc: Document, _options?: Partial<Pick<WriterOptions, "format" | "basename">>): Promise<JSONDocument>

Converts a Document to glTF-formatted JSON and a resource map.
- Defined in packages/core/src/io/platform-io.ts:135

Function symbol, f(📦) → 📦, where the argument and output are a box labeled 'glTF'.