@graphty/graphty-element / index / ExportResult

Interface: ExportResult

Defined in: graphty-element/src/data/export.ts:62

What exportGraph returns.

Properties

bytes

readonly bytes: AsyncIterable<Uint8Array<ArrayBufferLike>>

Defined in: graphty-element/src/data/export.ts:78

The output as UTF-8 chunks, for a file too large to hold as one string. Iterable more than once.

---

format

readonly format: FormatId

Defined in: graphty-element/src/data/export.ts:64

The format written.

---

lossNotes

readonly lossNotes: readonly LossNote[]

Defined in: graphty-element/src/data/export.ts:69

Everything the format could not carry, one note per kind of omission, from the exporter's check(). Empty only when the export is exact.

Methods

text()

text(): Promise<string>

Defined in: graphty-element/src/data/export.ts:76

The whole output as one string.

Returns

Promise<string>

The document.

Throws

A GraphtyError (as a rejection): E_UNSUPPORTED when the writer refuses this graph under these options, E_INTERNAL when it failed.