Creates a new FtNodeFileWriter that writes to a file.
The path to the file to write
The metadata defining the file structure
The character encoding to use (default: 'utf-8')
Optionalsettings: FtWriterSettings
Optional writer settings
Protected_Protected_OptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonOptionalonProtected Static ReadonlyCarriageProtected Static ReadonlyCarriageProtected Static ReadonlyLineStatic ReadonlyPrefixProtected Static ReadonlySignatureProtected Static ReadonlyVersionStatic ReadonlyVersionStatic ReadonlyVersionProtected Static ReadonlyVersionGets the underlying text writer.
Number of sequences currently invoked (depth of sequence invokation stack).
IDataReader member
Number of fields in the current record.
IDataReader member
Gets whether the writer is closed.
Enables use with the using declaration for automatic resource cleanup.
Closes the writer, flushing and releasing the underlying file handle.
ProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireProtectedfireFlush the writer.
Get a FtField object at index.
Get a FtField object by name.
Get the name of the field at the given index.
Get a field value by index. Returns null if the field value is null.
Get the value type of the field at the given index.
Name of the field at the given index. Alias for getFieldName.
IDataReader member
ProtectedinternalInternal load metadata. Override from SerializationCore.
Whether the field value at the given index is null. Alias for isFieldNull.
IDataReader member
Whether the field value at the given index is null.
Load configuration from FtMeta.
Open the writer with a FtTextWriter and optional settings.
The FtTextWriter to write to
Optionalsettings: FtWriterSettings
Optional writer settings (default: {})
ProtectedredirectProtectedresetReset serialization state.
Set a boolean field.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set a DateTime field's value.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set a decimal field.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set a field value by index. Accepts null to set the field to null.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set a float field.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set an integer field.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
ProtectedsetSet a field to null.
The 0-based index of the field to set.
Set a field to null.
The name of the field to set.
ProtectedsetSet a string field.
The 0-based index of the field to set.
The value to set for the field. Can be null to set the field to null.
Set multiple field values.
An array of values to set for the fields. The length of the array must not exceed the number of fields. Array elements can be null to set the corresponding field to null.
ProtectedunredirectWrite a record.
Write a comment line.
OptionalbeforeCommentChars: stringWrite the header (declaration, embedded meta, heading lines).
High-level writer for fielded text files that writes directly to the file system. Node.js-specific extension of FtWriter that accepts a file path. Provides a convenient single-class API for Node.js applications.