FieldedText TypeScript Library
    Preparing search index...

    Class FtNodeFileReader

    High-level reader for fielded text files that reads directly from the file system. Node.js-specific extension of FtReader that accepts a file path. Provides a convenient single-class API for Node.js applications.

    Hierarchy

    • FtReader
      • FtNodeFileReader
    Index
    constructor
    _recordCount _tableCount onFieldHeadingReadReady? onFieldHeadingWriteReady? onFieldValueReadReady? onFieldValueWriteReady? onHeadingLineFinished? onHeadingLineStarted? onRecordFinished? onRecordSeeked onRecordStarted? onRequireFileMetaAsText onRequireUrlMetaAsText onSequenceRedirected? CarriageReturnChar CarriageReturnLineFeedString LineFeedChar PrefixSpaceChar Signature VersionLabel VersionMajor VersionMinor VersionSeparator
    activeFieldIndex allowEndOfLineCharInQuotes allowIncompleteRecords autoNextTable culture declared delimiterChar depth endOfLineAutoWriteType endOfLineChar endOfLineType fieldCount fieldDefinitionList fieldList headerRead headingAlwaysWriteOptionalQuote headingConstraint headingEndOfValueChar headingLineCount headingLineReadCount headingPadAlignment headingPadChar headingPadCharType headingQuotedType headingTruncateChar headingTruncateType headingWritePrefixSpace ignoreBlankLines ignoreExtraChars ignoreExtraCharsLinePosition isClosed lastLineEndedType line lineCommentChar lineType mainHeadingLineIndex metaReference metaReferenceType newTableStarted previousRecordSequenceInvokationList quoteChar recordCount rootFieldCount rootSequence rootSequenceInvokation seeking sequenceInvokationList sequenceList stuffedEmbeddedQuotes substitutionChar substitutionList substitutionsEnabled tableCount
    [dispose] close fireFieldHeadingWriteReady fireFieldValueWriteReady fireHeadingLineFinished fireHeadingLineStarted fireRecordFinished fireRecordStarted fireSequenceRedirected getField getFieldByName getFieldIndexByName getFieldName getFieldNullableValue getFieldNullableValueByName getFieldValue getFieldValueByName getFieldValueType getFileMetaAsText getName getOrdinal getUrlMetaAsText internalLoadMeta isDBNull isFieldNull loadMeta loadMetaFromObject nextResult nextTable open read readHeader readLine readRecord readToEnd redirect reset seek seekEnd setLineCommentChar setSeeking tryGetSubstitutionValue unredirect

    • Creates a new FtNodeFileReader that reads from a file.

      Parameters

      • filePath: PathLike

        The path to the file to read

      • metaOrEncoding: BufferEncoding | FtMeta = 'utf-8'

        The metadata defining the file structure or the character encoding of the file containing the meta (if meta is not provided)

      • encoding: BufferEncoding = 'utf-8'

        The character encoding to use (default: 'utf-8')

      • immediatelyReadHeader: boolean = true

        Whether to automatically read header lines (default: true)

      Returns FtNodeFileReader

    Protected_recordCount

    _recordCount: number

    Protected_tableCount

    _tableCount: number
    onFieldHeadingReadReady?: (args: FtFieldHeadingReadyEventArgs) => void
    onFieldHeadingWriteReady?: (args: FtFieldHeadingReadyEventArgs) => void
    onFieldValueReadReady?: (args: FtFieldValueReadyEventArgs) => void
    onFieldValueWriteReady?: (args: FtFieldValueReadyEventArgs) => void
    onHeadingLineFinished?: (args: FtHeadingLineFinishedEventArgs) => void
    onHeadingLineStarted?: (args: FtHeadingLineStartedEventArgs) => void
    onRecordFinished?: (args: FtRecordFinishedEventArgs) => void
    onRecordSeeked: OnRecordSeeked | undefined

    Event fired when seeking through records.

    onRecordStarted?: (args: FtRecordStartedEventArgs) => void
    onRequireFileMetaAsText: OnRequireFileMetaAsText | undefined

    Event fired when needing to access file to get meta. This library is browser-compatible and does not have direct file system access, so this event allows the consumer to provide file content as text.

    onRequireUrlMetaAsText: OnRequireUrlMetaAsText | undefined

    Event fired when needing to access URL to get meta. Deferred to consumer as need to handle encoding and also must be returned synchronously

    onSequenceRedirected?: (args: FtSequenceRedirectedEventArgs) => void
    CarriageReturnChar: "\r"
    CarriageReturnLineFeedString: "\r\n"
    LineFeedChar: "\n"
    PrefixSpaceChar: " "
    Signature: "|!Fielded Text^|"
    VersionLabel: "Version"
    VersionMajor: 1
    VersionMinor: 1
    VersionSeparator: "."
    • get activeFieldIndex(): number

      Gets the active field index for the current line.

      Returns number

    • get allowEndOfLineCharInQuotes(): boolean

      Returns boolean

    • get allowIncompleteRecords(): boolean

      Returns boolean

    • get autoNextTable(): boolean

      Gets or sets whether Read() will automatically continue reading records when new tables begin.

      Returns boolean

    • set autoNextTable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get culture(): DotNetLocaleSettings

      Returns DotNetLocaleSettings

    • get declared(): boolean

      Gets whether the fielded text stream was declared (has |!Fielded Text^| signature).

      Returns boolean

    • get delimiterChar(): string

      Returns string

    • get depth(): number

      Number of sequences currently invoked (depth of sequence invokation stack).

      IDataReader member

      Returns number

    • get endOfLineAutoWriteType(): FtEndOfLineAutoWriteType

      Returns FtEndOfLineAutoWriteType

    • get endOfLineChar(): string

      Returns string

    • get endOfLineType(): FtEndOfLineType

      Returns FtEndOfLineType

    • get fieldCount(): number

      Number of fields in the current record.

      IDataReader member

      Returns number

    • get fieldDefinitionList(): FtFieldDefinitionList

      Returns FtFieldDefinitionList

    • get fieldList(): FtFieldList

      Returns FtFieldList

    • get headerRead(): boolean

      Gets whether the header has been fully read.

      Returns boolean

    • get headingAlwaysWriteOptionalQuote(): boolean

      Returns boolean

    • get headingConstraint(): FtHeadingConstraint

      Returns FtHeadingConstraint

    • get headingEndOfValueChar(): string

      Returns string

    • get headingLineCount(): number

      Returns number

    • get headingLineReadCount(): number

      Gets the number of heading lines read.

      Returns number

    • get headingPadAlignment(): FtPadAlignment

      Returns FtPadAlignment

    • get headingPadChar(): string

      Returns string

    • get headingPadCharType(): FtPadCharType

      Returns FtPadCharType

    • get headingQuotedType(): FtQuotedType

      Returns FtQuotedType

    • get headingTruncateChar(): string

      Returns string

    • get headingTruncateType(): FtTruncateType

      Returns FtTruncateType

    • get headingWritePrefixSpace(): boolean

      Returns boolean

    • get ignoreBlankLines(): boolean

      Returns boolean

    • get ignoreExtraChars(): boolean

      Returns boolean

    • get ignoreExtraCharsLinePosition(): number

      Gets the line position where extra characters started being ignored.

      Returns number

    • get isClosed(): boolean

      Gets whether the reader is closed.

      Returns boolean

    • get lastLineEndedType(): FtLastLineEndedType

      Returns FtLastLineEndedType

    • get line(): string

      Gets the last line read as a string.

      Returns string

    • get lineCommentChar(): string

      Returns string

    • get lineType(): FtLineType

      Gets the type of the last line read.

      Returns FtLineType

    • get mainHeadingLineIndex(): number

      Returns number

    • get metaReference(): string

      Gets the meta reference (file path or URL).

      Returns string

    • get metaReferenceType(): FtMetaReferenceType

      Gets the meta reference type.

      Returns FtMetaReferenceType

    • get newTableStarted(): boolean

      Gets whether the last record read was the start of a new table.

      Returns boolean

    • get previousRecordSequenceInvokationList(): FtSequenceInvokationList

      Returns FtSequenceInvokationList

    • get quoteChar(): string

      Returns string

    • get recordCount(): number

      Gets the number of records read (accounting for table start peeking).

      Returns number

    • get rootFieldCount(): number

      Returns number

    • get rootSequence(): FtSequence | undefined

      Returns FtSequence | undefined

    • get rootSequenceInvokation(): FtSequenceInvokation | undefined

      Returns FtSequenceInvokation | undefined

    • get seeking(): boolean

      Returns boolean

    • get sequenceInvokationList(): FtSequenceInvokationList

      Returns FtSequenceInvokationList

    • get sequenceList(): FtSequenceList

      Returns FtSequenceList

    • get stuffedEmbeddedQuotes(): boolean

      Returns boolean

    • get substitutionChar(): string

      Returns string

    • get substitutionList(): FtSubstitutionList

      Returns FtSubstitutionList

    • get substitutionsEnabled(): boolean

      Returns boolean

    • get tableCount(): number

      Gets the number of tables read (accounting for table start suspension).

      Returns number

    • Parameters

      • field: FtField
      • lineIndex: number

      Returns void

    • Parameters

      • field: FtField
      • recordIndex: number

      Returns void

    • Parameters

      • lineIndex: number

      Returns void

    • Parameters

      • lineIndex: number

      Returns void

    • Parameters

      • recordIndex: number

      Returns void

    • Parameters

      • recordIndex: number

      Returns void

    • Parameters

      • redirectingField: FtField
      • fieldsAffectedFromIndex: number

      Returns void

    • Get a FtField object at index.

      Parameters

      • idx: number

      Returns FtField

    • Get a FtField object by name.

      Parameters

      • name: string

      Returns FtField | undefined

    • Get a index of field in record by its name.

      Parameters

      • name: string

      Returns number | undefined

      Error if the field is not found.

    • Get the name of the field at the given index.

      Parameters

      • idx: number

      Returns string

    • Get a field value by index. Returns null if the field value is null.

      Parameters

      • idx: number

      Returns Value | null

    • Get a field value by name. Returns null if the field value is null.

      Parameters

      • name: string

      Returns Value | null

      Error if the field is not found.

    • Get a field value by index.

      Parameters

      • idx: number

      Returns Value | null

      FtFieldNullError if the field value is null.

    • Get a field value by name.

      Parameters

      • name: string

      Returns Value | null

      FtFieldNullError if the field value is null.

      Error if the field is not found.

    • Get the value type of the field at the given index.

      Parameters

      • idx: number

      Returns string

    • Parameters

      • fileMetaReference: string

      Returns string

    • Name of the field at the given index. Alias for getFieldName.

      IDataReader member

      Parameters

      • idx: number

      Returns string

    • Get a index of field in record by its name.

      IDataReader member

      Parameters

      • name: string

      Returns number

      Error if the field is not found.

    • Parameters

      • urlMetaReference: string

      Returns string | FileMetaAsTextResult

    • Parameters

      • meta: FtMeta

      Returns void

    • Whether the field value at the given index is null. Alias for isFieldNull.

      IDataReader member

      Parameters

      • idx: number

      Returns boolean

    • Whether the field value at the given index is null.

      Parameters

      • idx: number

      Returns boolean

    • Load configuration from FtMeta.

      Parameters

      • meta: FtMeta

      Returns void

    • Load metadata from a pre-parsed FtMeta object.

      Parameters

      • meta: FtMeta

        The metadata to load.

      Returns void

    • Alias for nextTable() (IDataReader compatibility).

      Returns boolean

      true if a new table was found, false if at end of stream.

    • Move to the next table in the stream.

      Returns boolean

      true if a new table was found, false if at end of stream.

    • Open the reader with a text string.

      Parameters

      • textReaderOrText: string | FtTextReader

        Text reader or string providing the data to read

      • OptionalimmediatelyReadHeader: boolean

        Whether to automatically read header lines (default: true)

      Returns void

    • Read the next record from the stream. Respects autoNextTable setting for table boundaries.

      Returns boolean

      true if a record was read, false otherwise.

    • Read the header (declaration, embedded meta, heading lines).

      Returns void

    • Read the next line from the stream. Always reads regardless of table boundaries.

      Returns boolean

      true if a line was read, false if at end of stream.

    • Read the next record and indicate table boundaries. Always reads regardless of table boundaries.

      Returns FtReadRecordResult

      Result indicating same table, new table, or no more records.

    • Read all remaining records. Normally used with event handlers.

      Returns void

    • Parameters

      • redirectingField: FtField
      • invokedSequence: FtSequence
      • invokationDelay: FtSequenceInvokationDelay

      Returns number

    • Reset serialization state.

      Returns void

    • Seek to a specific record offset.

      Parameters

      • offset: number

        The 1-based record offset to seek to.

      Returns boolean

      true if seek succeeded, false if offset beyond end.

    • Seek to the end of the stream.

      Returns void

    • Parameters

      • aChar: string

      Returns void

    • Parameters

      • value: boolean

      Returns void

    • Parameters

      • token: string

      Returns { found: boolean; value: string }

    • Parameters

      • unredirectingField: FtField

      Returns number

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    activeFieldIndexallowEndOfLineCharInQuotesallowIncompleteRecordsautoNextTableculturedeclareddelimiterChardepthendOfLineAutoWriteTypeendOfLineCharendOfLineTypefieldCountfieldDefinitionListfieldListheaderReadheadingAlwaysWriteOptionalQuoteheadingConstraintheadingEndOfValueCharheadingLineCountheadingLineReadCountheadingPadAlignmentheadingPadCharheadingPadCharTypeheadingQuotedTypeheadingTruncateCharheadingTruncateTypeheadingWritePrefixSpaceignoreBlankLinesignoreExtraCharsignoreExtraCharsLinePositionisClosedlastLineEndedTypelinelineCommentCharlineTypemainHeadingLineIndexmetaReferencemetaReferenceTypenewTableStartedpreviousRecordSequenceInvokationListquoteCharrecordCountrootFieldCountrootSequencerootSequenceInvokationseekingsequenceInvokationListsequenceListstuffedEmbeddedQuotessubstitutionCharsubstitutionListsubstitutionsEnabledtableCount
    Methods