Class PlatformIO`Abstract`

Abstract I/O base class for reading and writing FairyGUI projects.

Platform-specific adapters provide the file system abstraction required by the reader/writer.

Hierarchy (View Summary)

PlatformIO
- NodeIO

Index

Constructors

Methods

readBinary readProject writeBinary writeProject

Constructors

constructor

new PlatformIO(): PlatformIO

Returns PlatformIO

Methods

readBinary

readBinary(filePath: string): Promise<Document>
Parameters
- filePath: string
Returns Promise<Document>
- Defined in packages/core/src/io/platform-io.ts:31

readProject

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

writeBinary

writeBinary(
    doc: Document,
    filePath: string,
    options?: BinaryWriterOptions,
): Promise<void>
Parameters
- doc: Document
- filePath: string
- Optionaloptions: BinaryWriterOptions
Returns Promise<void>
- Defined in packages/core/src/io/platform-io.ts:37

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/platform-io.ts:25