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

    High-level API for event-driven serialization and deserialization of fielded text. Simplifies reading and writing by hooking into field and record events.

    Index

    Constructors

    Properties

    onFieldHeadingReadReady:
        | ((args: FtFieldHeadingReadyEventArgs) => void)
        | undefined = undefined
    onFieldHeadingWriteReady:
        | ((args: FtFieldHeadingReadyEventArgs) => void)
        | undefined = undefined
    onFieldValueReadReady: ((args: FtFieldValueReadyEventArgs) => void) | undefined = undefined
    onFieldValueWriteReady: ((args: FtFieldValueReadyEventArgs) => void) | undefined = undefined
    onHeadingLineFinished:
        | ((args: FtHeadingLineFinishedEventArgs) => void)
        | undefined = undefined
    onHeadingLineStarted:
        | ((args: FtHeadingLineStartedEventArgs) => void)
        | undefined = undefined
    onRecordFinished: ((args: FtRecordFinishedEventArgs) => void) | undefined = undefined
    onRecordStarted: ((args: FtRecordStartedEventArgs) => void) | undefined = undefined
    onSequenceRedirected:
        | ((args: FtSequenceRedirectedEventArgs) => void)
        | undefined = undefined
    PREFIX_SPACE_CHAR: " " = SerializationCore.PrefixSpaceChar
    VERSION_MAJOR: 1 = SerializationCore.VersionMajor
    VERSION_MINOR: 1 = SerializationCore.VersionMinor

    Accessors

    Methods

    • Read all records from a reader, invoking events for each field and record.

      Parameters

      • reader: FtReader

        The reader to deserialize from

      Returns void

    • Read all records from text input, invoking events for each field and record.

      Parameters

      • input: string

        The text content to deserialize

      Returns void