Header menu logo Nao

ConverterRegistry Type

A registry of format readers and writers, keyed by media type. This is the entry point for "A → unified → B": register one `IDocumentReader` and one `IDocumentWriter` per format, then call `Convert`.

Constructors

Constructor Description

ConverterRegistry()

Full Usage: ConverterRegistry()

Returns: ConverterRegistry

Instance members

Instance member Description

this.Convert

Full Usage: this.Convert

Parameters:

Convert in one step: read `sourceMediaType` from `input`, then write `targetMediaType` to `output`. This is the canonical A → unified → B path.

sourceMediaType : string
input : Stream
targetMediaType : string
output : Stream
ctx : ConversionContext

this.Read

Full Usage: this.Read

Parameters:
Returns: Document

Parse a source stream of the given media type into the unified model.

mediaType : string
input : Stream
ctx : ConversionContext
Returns: Document

this.ReadableTypes

Full Usage: this.ReadableTypes

Returns: string list

Media types that can be read from.

Returns: string list

this.RegisterReader

Full Usage: this.RegisterReader

Parameters:

Register a reader for all of its declared media types.

reader : IDocumentReader

this.RegisterWriter

Full Usage: this.RegisterWriter

Parameters:

Register a writer for all of its declared media types.

writer : IDocumentWriter

this.TryGetReader

Full Usage: this.TryGetReader

Parameters:
    mediaType : string

Returns: IDocumentReader option
mediaType : string
Returns: IDocumentReader option

this.TryGetWriter

Full Usage: this.TryGetWriter

Parameters:
    mediaType : string

Returns: IDocumentWriter option
mediaType : string
Returns: IDocumentWriter option

this.WritableTypes

Full Usage: this.WritableTypes

Returns: string list

Media types that can be written to.

Returns: string list

this.Write

Full Usage: this.Write

Parameters:

Serialize the unified model to a target media type.

mediaType : string
doc : Document
output : Stream
ctx : ConversionContext

Type something to start searching.