diff --git a/development/classes/parser.LcovParser.html b/development/classes/parser.LcovParser.html index 0945466e..0d9dfb34 100644 --- a/development/classes/parser.LcovParser.html +++ b/development/classes/parser.LcovParser.html @@ -1,7 +1,7 @@ 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

Properties

_buffer _chunks _fieldNames @@ -18,10 +18,10 @@ _parseSlice _parseValue _seekNextLine -

Constructors

constructor

Properties

Private Internal _buffer

_buffer: null | Buffer = null

Private Readonly Internal _chunks

_chunks: default<Buffer> = ...

Private Readonly Internal _fieldNames

_fieldNames: default[]

Private Internal _offset

_offset: number = 0

Private Readonly Internal _variants

_variants: Variant[]

Methods

Private _matchFields

Private _parseResult

Private _resetMatcher

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

Properties

Private Internal _buffer

_buffer: null | Buffer = null

Private Readonly Internal _chunks

_chunks: default<Buffer> = ...

Private Readonly Internal _fieldNames

_fieldNames: default[]

Private Internal _offset

_offset: number = 0

Private Readonly Internal _variants

_variants: Variant[]

Methods

Private _matchFields

Private _parseResult

Private _resetMatcher

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

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

Static Private _defaultResult

Static Private _parseSlice

  • _parseSlice(buf, start, end): string[]
  • Internal

    Parameters

    • buf: Buffer
    • start: number
    • end: number

    Returns string[]

Static Private _parseValue

  • _parseValue(buf, offset, startAtOffset): null | ParseValueResult
  • Internal

    Parameters

    • buf: Buffer
    • offset: number
    • startAtOffset: boolean

    Returns null | ParseValueResult

Static Private _seekNextLine

  • _seekNextLine(buf, offset): number

  • Parameters

    • buf: Buffer
    • offset: number

    Returns number

On This Page

\ No newline at end of file +

Returns void

Static Private _defaultResult

Static Private _parseSlice

Static Private _parseValue

Static Private _seekNextLine

On This Page

\ No newline at end of file diff --git a/development/classes/stream.LcovStreamParser.html b/development/classes/stream.LcovStreamParser.html index 2fe19fb3..8f54a203 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

_current _functionMap _parser @@ -99,7 +99,7 @@ setMaxListeners supportedEncoding toWeb -

Constructors

constructor

Properties

Private Internal _current

_current: SectionSummary = ...

Private Readonly Internal _functionMap

_functionMap: FunctionMap = ...

Private Internal _parser

_parser: LcovParser

allowHalfOpen

allowHalfOpen: boolean

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

Constructors

constructor

Properties

Private Internal _current

_current: SectionSummary = ...

Private Readonly Internal _functionMap

_functionMap: FunctionMap = ...

Private Internal _parser

_parser: LcovParser

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 existingDuplex stream instance, but must be changed before the 'end' event is @@ -163,7 +163,7 @@

Since

v13.6.0, v12.17.0

Methods

[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](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Optional [captureRejectionSymbol]

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

  • Type Parameters

    • K

    Parameters

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

    Returns void

Optional _construct

  • _construct(callback): void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_final

  • _final(callback): void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_flush

  • _flush(callback): void
  • Internal

    Parameters

    • callback: TransformCallback

    Returns void

Private _processResults

_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?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

addListener

  • addListener(event, listener): this

  • Event emitter +

[asyncIterator]

  • [asyncIterator](): AsyncIterableIterator<any>

  • Returns AsyncIterableIterator<any>

Optional [captureRejectionSymbol]

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

  • Type Parameters

    • K

    Parameters

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

    Returns void

Optional _construct

  • _construct(callback): void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_destroy

  • _destroy(error, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_final

  • _final(callback): void

  • Parameters

    • callback: ((error?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

_flush

  • _flush(callback): void
  • Internal

    Parameters

    • callback: TransformCallback

    Returns void

Private _processResults

_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?) => void)
        • (error?): void

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional _writev

  • _writev(chunks, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

addListener

  • addListener(event, listener): this

  • Event emitter The defined events on documents including:

    1. close
      2. @@ -422,7 +422,7 @@

    Parameters

    • stream: ReadableStream

      An "old style" readable stream

    Returns this

    Since

    v0.9.4

    -

write

  • write(chunk, encoding?, cb?): boolean

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • write(chunk, cb?): boolean

  • Parameters

    • chunk: any
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

Static Private _isTrailingBlankSpace

  • _isTrailingBlankSpace(buffer): boolean
  • Internal

    Parameters

    • buffer: Buffer

    Returns boolean

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    +

write

  • write(chunk, encoding?, cb?): boolean

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

  • write(chunk, cb?): boolean

  • Parameters

    • chunk: any
    • Optional cb: ((error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

Static Private _isTrailingBlankSpace

  • _isTrailingBlankSpace(buffer): boolean
  • Internal

    Parameters

    • buffer: Buffer

    Returns boolean

Static addAbortListener

  • addAbortListener(signal, resource): Disposable
  • Experimental

    Listens once to the abort event on the provided signal.

    Listening to the abort event on abort signals is unsafe and may lead to resource leaks since another third party with the signal can call e.stopImmediatePropagation(). Unfortunately Node.js cannot change @@ -522,6 +522,6 @@

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

Returns boolean

-

Static toWeb

Static toWeb

On This Page

\ No newline at end of file diff --git a/development/enums/constants.Variant.html b/development/enums/constants.Variant.html index f861aa03..efcecec2 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: 1

Number of branches hit.

-

BranchInstrumented

BranchInstrumented: 2

Number of branches found.

-

BranchLocation

BranchLocation: 3

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

-

Comment

Comment: 4

A comment string.

-

EndOfRecord

EndOfRecord: 5

Signals the end of a section.

-

FilePath

FilePath: 6

The source file path.

-

FunctionExecution

FunctionExecution: 7

Call count for a given function, identified by name.

-

FunctionHit

FunctionHit: 8

Number of functions hit.

-

FunctionInstrumented

FunctionInstrumented: 9

Number of functions found.

-

FunctionLocation

FunctionLocation: 10

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

-

LineHit

LineHit: 11

Number of lines with a non-zero execution count.

-

LineInstrumented

LineInstrumented: 12

Number of instrumented lines.

-

LineLocation

LineLocation: 13

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

-

None

None: 0

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

-

TestName

TestName: 14

The test name.

-

Version

Version: 15

The source code version ID.

-

On This Page

\ No newline at end of file +

BranchInstrumented

BranchInstrumented: 2

Number of branches found.

+

BranchLocation

BranchLocation: 3

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

+

Comment

Comment: 4

A comment string.

+

EndOfRecord

EndOfRecord: 5

Signals the end of a section.

+

FilePath

FilePath: 6

The source file path.

+

FunctionExecution

FunctionExecution: 7

Call count for a given function, identified by name.

+

FunctionHit

FunctionHit: 8

Number of functions hit.

+

FunctionInstrumented

FunctionInstrumented: 9

Number of functions found.

+

FunctionLocation

FunctionLocation: 10

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

+

LineHit

LineHit: 11

Number of lines with a non-zero execution count.

+

LineInstrumented

LineInstrumented: 12

Number of instrumented lines.

+

LineLocation

LineLocation: 13

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

+

None

None: 0

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

+

TestName

TestName: 14

The test name.

+

Version

Version: 15

The source code version ID.

+

On This Page

\ No newline at end of file diff --git a/development/functions/lib_field_variant.isEmptyField.html b/development/functions/lib_field_variant.isEmptyField.html index 0e3ea653..9e9c6d60 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

\ No newline at end of file +

Returns variant is EmptyVariants

\ No newline at end of file diff --git a/development/functions/lib_field_variant.isNonEmptyField.html b/development/functions/lib_field_variant.isNonEmptyField.html index f6342ee1..5c0eac93 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

\ No newline at end of file +

Returns variant is NonEmptyVariants

\ No newline at end of file diff --git a/development/functions/promise.lcovParser.html b/development/functions/promise.lcovParser.html index e6b5a23f..9e494029 100644 --- a/development/functions/promise.lcovParser.html +++ b/development/functions/promise.lcovParser.html @@ -1,3 +1,3 @@ lcovParser | LCOV parser

Function lcovParser

\ No newline at end of file +

Returns Promise<SectionSummary[]>

\ No newline at end of file diff --git a/development/interfaces/index.BranchEntry.html b/development/interfaces/index.BranchEntry.html index 7047213e..165d9245 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

\ No newline at end of file +

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

\ No newline at end of file diff --git a/development/interfaces/index.FieldNames.html b/development/interfaces/index.FieldNames.html index 1b78e81b..a435e475 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

\ No newline at end of file +

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

\ No newline at end of file diff --git a/development/interfaces/index.FunctionEntry.html b/development/interfaces/index.FunctionEntry.html index 2162dad9..1f77b623 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

\ No newline at end of file +

line

line: number

The associated line number.

+

name

name: string

Function name

+

On This Page

\ No newline at end of file diff --git a/development/interfaces/index.LineEntry.html b/development/interfaces/index.LineEntry.html index 62cf0bc6..f93870af 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

\ No newline at end of file +

line

line: number

The associated line number.

+

On This Page

\ No newline at end of file diff --git a/development/interfaces/index.SectionSummary.html b/development/interfaces/index.SectionSummary.html index 4640142a..f14a89c2 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

\ No newline at end of file +

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

\ No newline at end of file diff --git a/development/interfaces/index.Summary.html b/development/interfaces/index.Summary.html index 4730b97b..9716e74d 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

\ No newline at end of file +

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

\ No newline at end of file diff --git a/development/interfaces/parser.ParseResult.html b/development/interfaces/parser.ParseResult.html index 8b8d5d24..dbbd450a 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

\ No newline at end of file +

variant

variant: V

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

+

On This Page

\ No newline at end of file diff --git a/development/interfaces/promise.Options.html b/development/interfaces/promise.Options.html index 3fb3bf82..3573bf7c 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

Optional fieldNames

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.

-

Optional parser

parser?: LcovParser

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

-

On This Page

\ No newline at end of file +

Optional parser

parser?: LcovParser

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

+

On This Page

\ No newline at end of file diff --git a/development/interfaces/stream.StreamOptions.html b/development/interfaces/stream.StreamOptions.html index 2b1f3ecc..6b95f4a1 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, callback): void;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    read?(this, size): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): 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, callback): void;
    destroy?(this, error, callback): void;
    final?(this, callback): void;
    read?(this, size): void;
    write?(this, chunk, encoding, callback): void;
    writev?(this, chunks, callback): void;
}

Hierarchy

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

Properties

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

Properties

Optional allowHalfOpen

allowHalfOpen?: boolean

Optional autoDestroy

autoDestroy?: boolean

Optional defaultEncoding

defaultEncoding?: BufferEncoding

Optional emitClose

emitClose?: boolean

Optional encoding

encoding?: BufferEncoding

Optional fieldNames

fieldNames?: FieldNames

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

-

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional parser

parser?: LcovParser

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

-

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional signal

signal?: AbortSignal

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

+

Optional highWaterMark

highWaterMark?: number

Optional objectMode

objectMode?: boolean

Optional parser

parser?: LcovParser

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

+

Optional readableHighWaterMark

readableHighWaterMark?: number

Optional signal

signal?: AbortSignal

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

Optional writableCorked

writableCorked?: number

Optional writableHighWaterMark

writableHighWaterMark?: number

Methods

Optional construct

  • construct(this, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional destroy

  • destroy(this, error, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional final

  • final(this, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional read

  • read(this, size): void

  • Parameters

    • this: Transform
    • size: number

    Returns void

Optional write

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

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

Optional writev

  • writev(this, chunks, callback): void

  • Parameters

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

        • Parameters

          • Optional error: null | Error

          Returns void

    Returns void

On This Page

\ No newline at end of file diff --git a/development/modules/constants.html b/development/modules/constants.html index 6a0b69a1..eab83356 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
\ No newline at end of file diff --git a/development/modules/index.html b/development/modules/index.html index 34cb6e1e..31a4b23c 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 086f5f78..9facbad8 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 0e47ef38..d2856a40 100644 --- a/development/modules/parser.html +++ b/development/modules/parser.html @@ -1,3 +1,3 @@ -parser | LCOV parser

Module parser

Index

Classes

LcovParser +parser | LCOV parser

Module parser

Index

Classes

LcovParser

Interfaces

ParseResult
\ No newline at end of file diff --git a/development/modules/promise.html b/development/modules/promise.html index 2b111ed9..dc9d7d98 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

\ No newline at end of file diff --git a/development/modules/stream.html b/development/modules/stream.html index bf12523f..f1b44513 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

\ No newline at end of file diff --git a/development/types/lib_field_variant.EmptyVariants.html b/development/types/lib_field_variant.EmptyVariants.html index aa5ad385..c0f1fe83 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
\ No newline at end of file +EmptyVariants | LCOV parser

Type alias EmptyVariants

EmptyVariants: EndOfRecord | None
\ No newline at end of file diff --git a/development/types/lib_field_variant.NonEmptyVariants.html b/development/types/lib_field_variant.NonEmptyVariants.html index ea501421..59e0c5d8 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
\ No newline at end of file +NonEmptyVariants | LCOV parser

Type alias NonEmptyVariants

NonEmptyVariants: BranchHit | BranchInstrumented | BranchLocation | Comment | FilePath | FunctionExecution | FunctionHit | FunctionInstrumented | FunctionLocation | LineHit | LineInstrumented | LineLocation | TestName | Version
\ No newline at end of file diff --git a/development/variables/constants.defaultFieldNames.html b/development/variables/constants.defaultFieldNames.html index 794d97d8..bcaf65bb 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.

-
\ No newline at end of file +
\ No newline at end of file