From 736a4116c8bfe778c49b14a7b576b56179b2902b Mon Sep 17 00:00:00 2001 From: friedemannsommer Date: Sun, 3 Nov 2024 04:45:20 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20friedema?= =?UTF-8?q?nnsommer/lcov-parser@c6f57391256eaa47eb6e2f35697c786f6e67230f?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- development/classes/parser.LcovParser.html | 12 +++---- .../classes/stream.LcovStreamParser.html | 10 +++--- development/enums/constants.Variant.html | 34 +++++++++---------- .../lib_field_variant.isEmptyField.html | 2 +- .../lib_field_variant.isNonEmptyField.html | 2 +- development/functions/promise.lcovParser.html | 2 +- development/interfaces/index.BranchEntry.html | 12 +++---- development/interfaces/index.FieldNames.html | 4 +-- .../interfaces/index.FunctionEntry.html | 8 ++--- development/interfaces/index.LineEntry.html | 6 ++-- .../interfaces/index.SectionSummary.html | 12 +++---- development/interfaces/index.Summary.html | 8 ++--- .../interfaces/parser.ParseResult.html | 10 +++--- development/interfaces/promise.Options.html | 8 ++--- .../interfaces/stream.StreamOptions.html | 6 ++-- development/modules/constants.html | 2 +- development/modules/index.html | 2 +- development/modules/lib_field_variant.html | 2 +- development/modules/parser.html | 2 +- development/modules/promise.html | 2 +- development/modules/stream.html | 2 +- .../lib_field_variant.EmptyVariants.html | 2 +- .../lib_field_variant.NonEmptyVariants.html | 2 +- development/types/parser.FlushedResults.html | 2 +- .../constants.defaultFieldNames.html | 2 +- 25 files changed, 78 insertions(+), 78 deletions(-) diff --git a/development/classes/parser.LcovParser.html b/development/classes/parser.LcovParser.html index b80b32be..2af780e2 100644 --- a/development/classes/parser.LcovParser.html +++ b/development/classes/parser.LcovParser.html @@ -1,15 +1,15 @@ LcovParser | LCOV parser

Class LcovParser

Parses the given chunks based on the provided FieldNames. Please note that a LcovParser#write call doesn't imply any parsing, call the LcovParser#read or LcovParser#flush functions to parse the given chunks.

-

Constructors

constructor +

Constructors

constructor

Methods

flush getCurrentBuffer read write -

Constructors

constructor

Methods

flush

getCurrentBuffer

  • getCurrentBuffer(): null | Buffer

  • Returns null | Buffer

    Buffer - If there's a buffer available returns the remaining slice of it, otherwise returns null.

    -

read

  • read(): ParseResult<Variant>

  • Try to parse a result, this may fail if there's no or insufficient data. +

Constructors

constructor

Methods

flush

getCurrentBuffer

  • getCurrentBuffer(): null | Buffer

  • Returns null | Buffer

    Buffer - If there is a buffer available returns the remaining slice of it, otherwise returns null.

    +

read

write

write

  • write(chunk): void

  • Add the chunk to the list of chunks that should be parsed.

    Parameters

    • chunk: Buffer

      A Buffer with UTF-8 encoding

      -

    Returns void

On This Page

Constructors
Methods
+

Returns void

On This Page

Constructors
Methods
diff --git a/development/classes/stream.LcovStreamParser.html b/development/classes/stream.LcovStreamParser.html index cd9e59cb..b6f66ebc 100644 --- a/development/classes/stream.LcovStreamParser.html +++ b/development/classes/stream.LcovStreamParser.html @@ -1,6 +1,6 @@ LcovStreamParser | LCOV parser

Class LcovStreamParser

A Transform stream which accepts Buffer chunks as input and outputs SectionSummary objects.

-

Hierarchy

  • Transform
    • LcovStreamParser

Constructors

constructor +

Hierarchy

  • Transform
    • LcovStreamParser

Constructors

constructor

Properties

allowHalfOpen closed destroyed @@ -94,7 +94,7 @@ setMaxListeners supportedEncoding toWeb -

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean

If false then the stream will automatically end the writable side when the +

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean

If false then the stream will automatically end the writable side when the readable side ends. Set initially by the allowHalfOpen constructor option, which defaults to true.

This can be changed manually to change the half-open behavior of an existing @@ -184,7 +184,7 @@

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no regular 'error' listener is installed.

Since

v13.6.0, v12.17.0

-

Methods

Optional_construct

  • _construct(callback): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error, callback): void

  • Parameters

    • error: null | Error
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_final

  • _final(callback): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_flush

  • _flush(callback): void
  • Internal

    Parameters

    • callback: TransformCallback

    Returns void

_read

  • _read(size): void

  • Parameters

    • size: number

    Returns void

_transform

  • _transform(chunk, encoding, callback): void
  • Internal

    Parameters

    • chunk: Buffer
    • encoding: BufferEncoding
    • callback: TransformCallback

    Returns void

_write

  • _write(chunk, encoding, callback): void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optional_writev

  • _writev(chunks, callback): void

  • Parameters

    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

    +

Methods

Optional_construct

  • _construct(callback): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error, callback): void

  • Parameters

    • error: null | Error
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_final

  • _final(callback): void

  • Parameters

    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

_flush

  • _flush(callback): void
  • Internal

    Parameters

    • callback: TransformCallback

    Returns void

_read

  • _read(size): void

  • Parameters

    • size: number

    Returns void

_transform

  • _transform(chunk, encoding, callback): void
  • Internal

    Parameters

    • chunk: Buffer
    • encoding: BufferEncoding
    • callback: TransformCallback

    Returns void

_write

  • _write(chunk, encoding, callback): void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optional_writev

  • _writev(chunks, callback): void

  • Parameters

    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

[asyncDispose]

  • [asyncDispose](): Promise<void>

  • Calls readable.destroy() with an AbortError and returns a promise that fulfills when the stream is finished.

    Returns Promise<void>

    Since

    v20.4.0

[asyncIterator]

  • [asyncIterator](): AsyncIterator<any, any, any>

  • Returns AsyncIterator<any, any, any>

Optional[captureRejectionSymbol]

  • [captureRejectionSymbol]<K>(error, event, ...args): void

  • Type Parameters

    • K

    Parameters

    • error: Error
    • event: string | symbol
    • Rest...args: AnyRest

    Returns void

addListener

  • addListener(event, listener): this

  • Event emitter The defined events on documents including:

    @@ -641,11 +641,11 @@ objects.

Returns void

Since

v15.4.0

StaticsupportedEncoding

StatictoWeb

StatictoWeb

On This Page

Constructors
Properties
Methods
diff --git a/development/enums/constants.Variant.html b/development/enums/constants.Variant.html index 2529ad5a..3514afd0 100644 --- a/development/enums/constants.Variant.html +++ b/development/enums/constants.Variant.html @@ -1,5 +1,5 @@ Variant | LCOV parser

Enumeration Variant

Field entry variants

-

Enumeration Members

BranchHit +

Enumeration Members

BranchHit BranchInstrumented BranchLocation Comment @@ -16,19 +16,19 @@ TestName Version

Enumeration Members

BranchHit

BranchHit

Number of branches hit.

-

BranchInstrumented

BranchInstrumented

Number of branches found.

-

BranchLocation

BranchLocation

Provides branch coverage information, such as line number, block ID, branch, and how often it was used.

-

Comment

Comment

A comment string.

-

EndOfRecord

EndOfRecord

Signals the end of a section.

-

FilePath

FilePath

The source file path.

-

FunctionExecution

FunctionExecution

Call count for a given function, identified by name.

-

FunctionHit

FunctionHit

Number of functions hit.

-

FunctionInstrumented

FunctionInstrumented

Number of functions found.

-

FunctionLocation

FunctionLocation

Start and end line numbers for a given function, identified by name.

-

LineHit

LineHit

Number of lines with a non-zero execution count.

-

LineInstrumented

LineInstrumented

Number of instrumented lines.

-

LineLocation

LineLocation

The execution count for a line, identified by line number.

-

None

None

Used for parser.ParseResult#incomplete and parser.ParseResult#done results.

-

TestName

TestName

The test name.

-

Version

Version

The source code version ID.

-

On This Page

Enumeration Members
+

BranchInstrumented

BranchInstrumented

Number of branches found.

+

BranchLocation

BranchLocation

Provides branch coverage information, such as line number, block ID, branch, and how often it was used.

+

Comment

Comment

A comment string.

+

EndOfRecord

EndOfRecord

Signals the end of a section.

+

FilePath

FilePath

The source file path.

+

FunctionExecution

FunctionExecution

Call count for a given function, identified by name.

+

FunctionHit

FunctionHit

Number of functions hit.

+

FunctionInstrumented

FunctionInstrumented

Number of functions found.

+

FunctionLocation

FunctionLocation

Start and end line numbers for a given function, identified by name.

+

LineHit

LineHit

Number of lines with a non-zero execution count.

+

LineInstrumented

LineInstrumented

Number of instrumented lines.

+

LineLocation

LineLocation

The execution count for a line, identified by line number.

+

None

None

Used for parser.ParseResult#incomplete and parser.ParseResult#done results.

+

TestName

TestName

The test name.

+

Version

Version

The source code version ID.

+

On This Page

Enumeration Members
diff --git a/development/functions/lib_field_variant.isEmptyField.html b/development/functions/lib_field_variant.isEmptyField.html index 4a6a0654..49ef7cd6 100644 --- a/development/functions/lib_field_variant.isEmptyField.html +++ b/development/functions/lib_field_variant.isEmptyField.html @@ -1,3 +1,3 @@ isEmptyField | LCOV parser

Function isEmptyField

+

Returns variant is EmptyVariants

diff --git a/development/functions/lib_field_variant.isNonEmptyField.html b/development/functions/lib_field_variant.isNonEmptyField.html index 7871a072..c88ace67 100644 --- a/development/functions/lib_field_variant.isNonEmptyField.html +++ b/development/functions/lib_field_variant.isNonEmptyField.html @@ -1,3 +1,3 @@ isNonEmptyField | LCOV parser

Function isNonEmptyField

+

Returns variant is NonEmptyVariants

diff --git a/development/functions/promise.lcovParser.html b/development/functions/promise.lcovParser.html index 9ca364b4..5433a600 100644 --- a/development/functions/promise.lcovParser.html +++ b/development/functions/promise.lcovParser.html @@ -1,3 +1,3 @@ lcovParser | LCOV parser

Function lcovParser

+

Returns Promise<SectionSummary[]>

diff --git a/development/interfaces/index.BranchEntry.html b/development/interfaces/index.BranchEntry.html index 9da691e1..99cd3947 100644 --- a/development/interfaces/index.BranchEntry.html +++ b/development/interfaces/index.BranchEntry.html @@ -1,11 +1,11 @@ -BranchEntry | LCOV parser

Interface BranchEntry

interface BranchEntry {
    block: number;
    branch: string;
    hit: number;
    isException: boolean;
    line: number;
}

Hierarchy (view full)

Properties

block +BranchEntry | LCOV parser

Interface BranchEntry

interface BranchEntry {
    block: number;
    branch: string;
    hit: number;
    isException: boolean;
    line: number;
}

Hierarchy (view full)

Properties

block branch hit isException line

Properties

block

block: number

The block number.

-

branch

branch: string

A human-readable string, which should uniquely identify a given branch.

-

hit

hit: number

Number of executions for this line.

-

isException

isException: boolean

Possibly a catch or otherwise exception related branch.

-

line

line: number

The associated line number.

-

On This Page

Properties
+

branch

branch: string

A human-readable string, which should uniquely identify a given branch.

+

hit

hit: number

Number of executions for this line.

+

isException

isException: boolean

Possibly a catch or otherwise exception-related branch.

+

line

line: number

The associated line number.

+

On This Page

Properties
diff --git a/development/interfaces/index.FieldNames.html b/development/interfaces/index.FieldNames.html index 567fa49f..5b5a21ab 100644 --- a/development/interfaces/index.FieldNames.html +++ b/development/interfaces/index.FieldNames.html @@ -1,4 +1,4 @@ -FieldNames | LCOV parser

Interface FieldNames

interface FieldNames {
    branchHit: string;
    branchInstrumented: string;
    branchLocation: string;
    comment: string;
    endOfRecord: string;
    filePath: string;
    functionExecution: string;
    functionHit: string;
    functionInstrumented: string;
    functionLocation: string;
    lineHit: string;
    lineInstrumented: string;
    lineLocation: string;
    testName: string;
    version: string;
}

Properties

branchHit +FieldNames | LCOV parser

Interface FieldNames

interface FieldNames {
    branchHit: string;
    branchInstrumented: string;
    branchLocation: string;
    comment: string;
    endOfRecord: string;
    filePath: string;
    functionExecution: string;
    functionHit: string;
    functionInstrumented: string;
    functionLocation: string;
    lineHit: string;
    lineInstrumented: string;
    lineLocation: string;
    testName: string;
    version: string;
}

Properties

branchHit branchInstrumented branchLocation comment @@ -13,4 +13,4 @@ lineLocation testName version -

Properties

branchHit

branchHit: string

branchInstrumented

branchInstrumented: string

branchLocation

branchLocation: string

comment

comment: string

endOfRecord

endOfRecord: string

filePath

filePath: string

functionExecution

functionExecution: string

functionHit

functionHit: string

functionInstrumented

functionInstrumented: string

functionLocation

functionLocation: string

lineHit

lineHit: string

lineInstrumented

lineInstrumented: string

lineLocation

lineLocation: string

testName

testName: string

version

version: string

On This Page

Properties
+

Properties

branchHit

branchHit: string

branchInstrumented

branchInstrumented: string

branchLocation

branchLocation: string

comment

comment: string

endOfRecord

endOfRecord: string

filePath

filePath: string

functionExecution

functionExecution: string

functionHit

functionHit: string

functionInstrumented

functionInstrumented: string

functionLocation

functionLocation: string

lineHit

lineHit: string

lineInstrumented

lineInstrumented: string

lineLocation

lineLocation: string

testName

testName: string

version

version: string

On This Page

Properties
diff --git a/development/interfaces/index.FunctionEntry.html b/development/interfaces/index.FunctionEntry.html index 629ad8ac..31417335 100644 --- a/development/interfaces/index.FunctionEntry.html +++ b/development/interfaces/index.FunctionEntry.html @@ -1,7 +1,7 @@ -FunctionEntry | LCOV parser

Interface FunctionEntry

interface FunctionEntry {
    hit: number;
    line: number;
    name: string;
}

Hierarchy (view full)

Properties

hit +FunctionEntry | LCOV parser

Interface FunctionEntry

interface FunctionEntry {
    hit: number;
    line: number;
    name: string;
}

Hierarchy (view full)

Properties

hit line name

Properties

hit

hit: number

Number of executions for this line.

-

line

line: number

The associated line number.

-

name

name: string

Function name

-

On This Page

Properties
+

line

line: number

The associated line number.

+

name

name: string

Function name

+

On This Page

Properties
diff --git a/development/interfaces/index.LineEntry.html b/development/interfaces/index.LineEntry.html index 79b9ef4a..eafef84a 100644 --- a/development/interfaces/index.LineEntry.html +++ b/development/interfaces/index.LineEntry.html @@ -1,5 +1,5 @@ -LineEntry | LCOV parser

Interface LineEntry

interface LineEntry {
    hit: number;
    line: number;
}

Hierarchy (view full)

Properties

hit +LineEntry | LCOV parser

Interface LineEntry

interface LineEntry {
    hit: number;
    line: number;
}

Hierarchy (view full)

Properties

hit line

Properties

hit

hit: number

Number of executions for this line.

-

line

line: number

The associated line number.

-

On This Page

Properties
+

line

line: number

The associated line number.

+

On This Page

Properties
diff --git a/development/interfaces/index.SectionSummary.html b/development/interfaces/index.SectionSummary.html index 690bb2dc..60df1bd7 100644 --- a/development/interfaces/index.SectionSummary.html +++ b/development/interfaces/index.SectionSummary.html @@ -1,11 +1,11 @@ -SectionSummary | LCOV parser

Interface SectionSummary

interface SectionSummary {
    branches: Summary<BranchEntry>;
    functions: Summary<FunctionEntry>;
    lines: Summary<LineEntry>;
    name: string;
    path: string;
}

Properties

branches +SectionSummary | LCOV parser

Interface SectionSummary

interface SectionSummary {
    branches: Summary<BranchEntry>;
    functions: Summary<FunctionEntry>;
    lines: Summary<LineEntry>;
    name: string;
    path: string;
}

Properties

branches functions lines name path

Properties

branches

branches: Summary<BranchEntry>

The overall number of branches found and how often they were hit, with a list of instrumented branches.

-

functions

functions: Summary<FunctionEntry>

The overall number of functions found and how often they were hit, with a list of instrumented functions.

-

lines

lines: Summary<LineEntry>

The overall number of found lines and how often they were hit, with a list of instrumented lines.

-

name

name: string

The section name (also referred to as "test name").

-

path

path: string

The source file path.

-

On This Page

Properties
+

functions

functions: Summary<FunctionEntry>

The overall number of functions found and how often they were hit, with a list of instrumented functions.

+

lines

lines: Summary<LineEntry>

The overall number of found lines and how often they were hit, with a list of instrumented lines.

+

name

name: string

The section name (also referred to as "test name").

+

path

path: string

The source file path.

+

On This Page

Properties
diff --git a/development/interfaces/index.Summary.html b/development/interfaces/index.Summary.html index c30efaa5..7049e689 100644 --- a/development/interfaces/index.Summary.html +++ b/development/interfaces/index.Summary.html @@ -1,7 +1,7 @@ -Summary | LCOV parser

Interface Summary<Detail>

interface Summary<Detail> {
    details: Detail[];
    hit: number;
    instrumented: number;
}

Type Parameters

Properties

details +Summary | LCOV parser

Interface Summary<Detail>

interface Summary<Detail> {
    details: Detail[];
    hit: number;
    instrumented: number;
}

Type Parameters

Properties

details hit instrumented

Properties

details

details: Detail[]

Lists all instrumented branches, functions, or lines.

-

hit

hit: number

The number of executions for this branch, function, or line.

-

instrumented

instrumented: number

The number of branches, functions, or lines found.

-

On This Page

Properties
+

hit

hit: number

The number of executions for this branch, function, or line.

+

instrumented

instrumented: number

The number of branches, functions, or lines found.

+

On This Page

Properties
diff --git a/development/interfaces/parser.ParseResult.html b/development/interfaces/parser.ParseResult.html index dbd4d181..dce3f534 100644 --- a/development/interfaces/parser.ParseResult.html +++ b/development/interfaces/parser.ParseResult.html @@ -1,13 +1,13 @@ ParseResult | LCOV parser

Interface ParseResult<V>

A parsed LCOV field entry. It may be incomplete, check the ParseResult#done and ParseResult#incomplete fields.

-
interface ParseResult<V> {
    done: boolean;
    incomplete: boolean;
    value: null | string[];
    variant: V;
}

Type Parameters

Properties

done +
interface ParseResult<V> {
    done: boolean;
    incomplete: boolean;
    value: null | string[];
    variant: V;
}

Type Parameters

Properties

done incomplete value variant

Properties

done

done: boolean

Signals that this is the last entry.

-

incomplete

incomplete: boolean

Signals that there wasn't enough data to successfully parse the current buffer +

incomplete

incomplete: boolean

Signals that there wasn't enough data to successfully parse the current buffer and more data is necessary to parse it successfully.

-

value

value: null | string[]

A list of string values which were present after the : (colon) separator, or null +

value

value: null | string[]

A list of string values which were present after the : (colon) separator, or null if the current variant shouldn't have values.

-

variant

variant: V

Variant fo the current field entry. See Variant for more information.

-

On This Page

Properties
+

variant

variant: V

Variant of the current field entry. See Variant for more information.

+

On This Page

Properties
diff --git a/development/interfaces/promise.Options.html b/development/interfaces/promise.Options.html index 242ffad4..597dac50 100644 --- a/development/interfaces/promise.Options.html +++ b/development/interfaces/promise.Options.html @@ -1,8 +1,8 @@ -Options | LCOV parser

Interface Options

interface Options {
    fieldNames?: FieldNames;
    from:
        | string
        | ArrayBuffer
        | Buffer
        | Readable;
    parser?: LcovParser;
}

Properties

fieldNames? +Options | LCOV parser

Interface Options

interface Options {
    fieldNames?: FieldNames;
    from:
        | string
        | ArrayBuffer
        | Buffer
        | Readable;
    parser?: LcovParser;
}

Properties

fieldNames? from parser?

Properties

OptionalfieldNames

fieldNames?: FieldNames

The field names to use for parsing. These will only be used if Options#parser is not present.

-

from

from:
    | string
    | ArrayBuffer
    | Buffer
    | Readable

Input source to read from. +

from

from:
    | string
    | ArrayBuffer
    | Buffer
    | Readable

Input source to read from. This can be a string, Readable, Buffer, or ArrayBuffer.

-

Optionalparser

parser?: LcovParser

A parser instance that should be used for parsing, instead of creating a new one internally.

-

On This Page

Properties
+

Optionalparser

parser?: LcovParser

A parser instance that should be used for parsing instead of creating a new one internally.

+

On This Page

Properties
diff --git a/development/interfaces/stream.StreamOptions.html b/development/interfaces/stream.StreamOptions.html index c71237c8..cbfe9364 100644 --- a/development/interfaces/stream.StreamOptions.html +++ b/development/interfaces/stream.StreamOptions.html @@ -1,4 +1,4 @@ -StreamOptions | LCOV parser

Interface StreamOptions

interface StreamOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    fieldNames?: FieldNames;
    highWaterMark?: number;
    objectMode?: boolean;
    parser?: LcovParser;
    readableHighWaterMark?: number;
    signal?: AbortSignal;
    writableCorked?: number;
    writableHighWaterMark?: number;
    construct?(this: Transform, callback: ((error?: null | Error) => void)): void;
    destroy?(this: Transform, error: null | Error, callback: ((error?: null | Error) => void)): void;
    final?(this: Transform, callback: ((error?: null | Error) => void)): void;
    read?(this: Transform, size: number): void;
    write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: ((error?: null | Error) => void)): void;
    writev?(this: Transform, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: ((error?: null | Error) => void)): void;
}

Hierarchy

  • Omit<TransformOptions,
        | "transform"
        | "flush"
        | "writableObjectMode"
        | "readableObjectMode"
        | "decodeStrings">
    • StreamOptions

Properties

allowHalfOpen? +StreamOptions | LCOV parser

Interface StreamOptions

interface StreamOptions {
    allowHalfOpen?: boolean;
    autoDestroy?: boolean;
    defaultEncoding?: BufferEncoding;
    emitClose?: boolean;
    encoding?: BufferEncoding;
    fieldNames?: FieldNames;
    highWaterMark?: number;
    objectMode?: boolean;
    parser?: LcovParser;
    readableHighWaterMark?: number;
    signal?: AbortSignal;
    writableCorked?: number;
    writableHighWaterMark?: number;
    construct?(this: Transform, callback: ((error?: null | Error) => void)): void;
    destroy?(this: Transform, error: null | Error, callback: ((error?: null | Error) => void)): void;
    final?(this: Transform, callback: ((error?: null | Error) => void)): void;
    read?(this: Transform, size: number): void;
    write?(this: Transform, chunk: any, encoding: BufferEncoding, callback: ((error?: null | Error) => void)): void;
    writev?(this: Transform, chunks: {
        chunk: any;
        encoding: BufferEncoding;
    }[], callback: ((error?: null | Error) => void)): void;
}

Hierarchy

  • Omit<TransformOptions,
        | "transform"
        | "flush"
        | "writableObjectMode"
        | "readableObjectMode"
        | "decodeStrings">
    • StreamOptions

Properties

allowHalfOpen? autoDestroy? defaultEncoding? emitClose? @@ -18,6 +18,6 @@ write? writev?

Properties

OptionalallowHalfOpen

allowHalfOpen?: boolean

OptionalautoDestroy

autoDestroy?: boolean

OptionaldefaultEncoding

defaultEncoding?: BufferEncoding

OptionalemitClose

emitClose?: boolean

Optionalencoding

encoding?: BufferEncoding

OptionalfieldNames

fieldNames?: FieldNames

The field names to use for parsing. These will only be used if StreamOptions#parser is not present.

-

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

Optionalparser

parser?: LcovParser

A parser instance that should be used for parsing, instead of creating a new one internally.

-

OptionalreadableHighWaterMark

readableHighWaterMark?: number

Optionalsignal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

+

OptionalhighWaterMark

highWaterMark?: number

OptionalobjectMode

objectMode?: boolean

Optionalparser

parser?: LcovParser

A parser instance that should be used for parsing instead of creating a new one internally.

+

OptionalreadableHighWaterMark

readableHighWaterMark?: number

Optionalsignal

signal?: AbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

OptionalwritableCorked

writableCorked?: number

OptionalwritableHighWaterMark

writableHighWaterMark?: number

Methods

Optionalconstruct

  • construct(this, callback): void

  • Parameters

    • this: Transform
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionaldestroy

  • destroy(this, error, callback): void

  • Parameters

    • this: Transform
    • error: null | Error
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionalfinal

  • final(this, callback): void

  • Parameters

    • this: Transform
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionalread

  • read(this, size): void

  • Parameters

    • this: Transform
    • size: number

    Returns void

Optionalwrite

  • write(this, chunk, encoding, callback): void

  • Parameters

    • this: Transform
    • chunk: any
    • encoding: BufferEncoding
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

Optionalwritev

  • writev(this, chunks, callback): void

  • Parameters

    • this: Transform
    • chunks: {
          chunk: any;
          encoding: BufferEncoding;
      }[]
    • callback: ((error?: null | Error) => void)
        • (error?): void

        • Parameters

          • Optionalerror: null | Error

          Returns void

    Returns void

On This Page

Properties
Methods
diff --git a/development/modules/constants.html b/development/modules/constants.html index 8382b191..6f82a51b 100644 --- a/development/modules/constants.html +++ b/development/modules/constants.html @@ -1,3 +1,3 @@ -constants | LCOV parser

Module constants

Index

Enumerations

Variant +constants | LCOV parser

Module constants

Index

Enumerations

Variant

Variables

defaultFieldNames
diff --git a/development/modules/index.html b/development/modules/index.html index 9bb7b7ec..8b21db6f 100644 --- a/development/modules/index.html +++ b/development/modules/index.html @@ -1,4 +1,4 @@ -index | LCOV parser

Module index

References

default +index | LCOV parser

Module index

References

default lcovParser

Interfaces

BranchEntry FieldNames diff --git a/development/modules/lib_field_variant.html b/development/modules/lib_field_variant.html index 13a03402..6b2d6ddb 100644 --- a/development/modules/lib_field_variant.html +++ b/development/modules/lib_field_variant.html @@ -1,4 +1,4 @@ -lib/field-variant | LCOV parser

Module lib/field-variant

Index

Type Aliases

EmptyVariants +lib/field-variant | LCOV parser

Module lib/field-variant

Index

Type Aliases

EmptyVariants NonEmptyVariants

Functions

isEmptyField isNonEmptyField diff --git a/development/modules/parser.html b/development/modules/parser.html index 3bed9722..a49ef43e 100644 --- a/development/modules/parser.html +++ b/development/modules/parser.html @@ -1,4 +1,4 @@ -parser | LCOV parser

Module parser

Index

Classes

LcovParser +parser | LCOV parser

Module parser

Index

Classes

LcovParser

Interfaces

ParseResult

Type Aliases

FlushedResults
diff --git a/development/modules/promise.html b/development/modules/promise.html index 5669bd5f..8ab88a79 100644 --- a/development/modules/promise.html +++ b/development/modules/promise.html @@ -1,4 +1,4 @@ -promise | LCOV parser

Module promise

References

default +promise | LCOV parser

Module promise

References

default

Interfaces

Options

Functions

lcovParser

References

default

Renames and re-exports lcovParser

On This Page

References
diff --git a/development/modules/stream.html b/development/modules/stream.html index 55158b76..dc962e00 100644 --- a/development/modules/stream.html +++ b/development/modules/stream.html @@ -1,4 +1,4 @@ -stream | LCOV parser

Module stream

References

default +stream | LCOV parser

Module stream

References

default

Classes

LcovStreamParser

Interfaces

StreamOptions

References

default

Renames and re-exports LcovStreamParser

On This Page

References
diff --git a/development/types/lib_field_variant.EmptyVariants.html b/development/types/lib_field_variant.EmptyVariants.html index 8e2d371f..ff85bcef 100644 --- a/development/types/lib_field_variant.EmptyVariants.html +++ b/development/types/lib_field_variant.EmptyVariants.html @@ -1 +1 @@ -EmptyVariants | LCOV parser

Type Alias EmptyVariants

EmptyVariants: EndOfRecord | None
+EmptyVariants | LCOV parser

Type Alias EmptyVariants

EmptyVariants: EndOfRecord | None
diff --git a/development/types/lib_field_variant.NonEmptyVariants.html b/development/types/lib_field_variant.NonEmptyVariants.html index b5a93a6c..efdf61cf 100644 --- a/development/types/lib_field_variant.NonEmptyVariants.html +++ b/development/types/lib_field_variant.NonEmptyVariants.html @@ -1 +1 @@ -NonEmptyVariants | LCOV parser

Type Alias NonEmptyVariants

NonEmptyVariants:
    | BranchHit
    | BranchInstrumented
    | BranchLocation
    | Comment
    | FilePath
    | FunctionExecution
    | FunctionHit
    | FunctionInstrumented
    | FunctionLocation
    | LineHit
    | LineInstrumented
    | LineLocation
    | TestName
    | Version
+NonEmptyVariants | LCOV parser

Type Alias NonEmptyVariants

NonEmptyVariants:
    | BranchHit
    | BranchInstrumented
    | BranchLocation
    | Comment
    | FilePath
    | FunctionExecution
    | FunctionHit
    | FunctionInstrumented
    | FunctionLocation
    | LineHit
    | LineInstrumented
    | LineLocation
    | TestName
    | Version
diff --git a/development/types/parser.FlushedResults.html b/development/types/parser.FlushedResults.html index 805a3b16..393c478c 100644 --- a/development/types/parser.FlushedResults.html +++ b/development/types/parser.FlushedResults.html @@ -1,4 +1,4 @@ FlushedResults | LCOV parser

Type Alias FlushedResults

FlushedResults: [ParseResult, ...ParseResult[]]

A list of ParseResults that have been flushed from the parser. This typing is used to make it clear that there will always be at least one result.

See

LcovParser#flush

-
+
diff --git a/development/variables/constants.defaultFieldNames.html b/development/variables/constants.defaultFieldNames.html index a19a67fd..22adf87e 100644 --- a/development/variables/constants.defaultFieldNames.html +++ b/development/variables/constants.defaultFieldNames.html @@ -1,3 +1,3 @@ defaultFieldNames | LCOV parser

Variable defaultFieldNamesConst

defaultFieldNames: Readonly<FieldNames> = ...

The default names as specified in the linux-test-project/lcov/geninfo description.

-
+