Class WebIO

Browser-safe I/O implementation for reading and writing FairyGUI projects.

WebIO performs project read/write only. Browser artifact publish is exposed by @openfairygui/functions/web; binary package I/O is intentionally not exposed from this browser entrypoint.

Index

Constructors

Methods

readProject writeProject

Constructors

constructor

new WebIO(fileSystemOrOptions: FileSystem | WebIOOptions): WebIO
Parameters
- fileSystemOrOptions: FileSystem | WebIOOptions
Returns WebIO
- Defined in packages/core/src/io/web-io.ts:173

Methods

readProject

readProject(
projectPath: string,
options?: ProjectReadOptions,
): Promise<Document>
Parameters
- projectPath: string
- Optionaloptions: ProjectReadOptions
Returns Promise<Document>
- Defined in packages/core/src/io/web-io.ts:179

writeProject

writeProject(
    doc: Document,
    projectPath: string,
    options?: ProjectWriteOptions,
): Promise<void>
Parameters
- doc: Document
- projectPath: string
- Optionaloptions: ProjectWriteOptions
Returns Promise<void>
- Defined in packages/core/src/io/web-io.ts:183