Interface FileLog

A StreamWriter over a log file. Close when done.

interface FileLog {
    batch(fn: (b: Builder) => void): void;
    close(): void;
    group(name: string, headers?: string[] | null): void;
    header(...names: string[]): void;
    record(...fields: string[]): void;
    recordArray(fields: string[]): void;
}

Hierarchy (View Summary)

StreamWriter
- FileLog

Index

Methods

batch close group header record recordArray

Methods

batch

batch(fn: (b: Builder) => void): void
Append several records under a single commit. The batch is atomic: a tear anywhere inside it discards the whole block.
Parameters
- fn: (b: Builder) => void
Returns void
Inherited from StreamWriter.batch
- Defined in src/stream.ts:176

close

close(): void
Returns void
- Defined in src/stream.ts:191

group

group(name: string, headers?: string[] | null): void
Append a group preamble (GS + name) as a committed block.
Parameters
- name: string
- Optionalheaders: string[] | null
Returns void
Inherited from StreamWriter.group
- Defined in src/stream.ts:168

header(...names: string[]): void
Append an SOH header as a committed block.
Parameters
- ...names: string[]
Returns void
Inherited from StreamWriter.header
- Defined in src/stream.ts:163

record

record(...fields: string[]): void
Append one record as a committed block.
Parameters
- ...fields: string[]
Returns void
Inherited from StreamWriter.record
- Defined in src/stream.ts:153

recordArray

recordArray(fields: string[]): void
Append one record from an array of fields.
Parameters
- fields: string[]
Returns void
Inherited from StreamWriter.recordArray
- Defined in src/stream.ts:158