FieldedText TypeScript Library - v0.1.2
    Preparing search index...

    Interface FtWriterSettings

    Settings for writing fielded text streams.

    interface FtWriterSettings {
        declared?: boolean;
        embeddedMetaExplicitIndices?: boolean;
        embeddedMetaFormat?: FtMetaSerializationFormat;
        embeddedMetaIndent?: boolean;
        embeddedMetaIndentChars?: string;
        embeddedMetaNewLineOnAttributes?: boolean;
        metaReference?: string;
        metaReferenceType?: FtMetaReferenceType;
    }
    Index

    Properties

    declared? embeddedMetaExplicitIndices? embeddedMetaFormat? embeddedMetaIndent? embeddedMetaIndentChars? embeddedMetaNewLineOnAttributes? metaReference? metaReferenceType?

    Properties

    declared?: boolean

    Whether to write the |!Fielded Text^| declaration header.

    embeddedMetaExplicitIndices?: boolean

    Whether to include explicit index attributes for fields in embedded meta.

    embeddedMetaFormat?: FtMetaSerializationFormat

    Format of embedded meta to write.

    embeddedMetaIndent?: boolean

    Whether to indent embedded XML metadata.

    embeddedMetaIndentChars?: string

    Characters to use for indenting embedded XML metadata.

    embeddedMetaNewLineOnAttributes?: boolean

    Whether to write XML attributes on separate lines.

    metaReference?: string

    Meta reference (file path or URL).

    metaReferenceType?: FtMetaReferenceType

    Type of meta reference to write.

    Settings

    Member Visibility

    On This Page

    Properties