From 7c6fe3e7697f9c841a9d8203fd9bfabd9b8b104d Mon Sep 17 00:00:00 2001 From: friedemannsommer Date: Fri, 1 Nov 2024 22:52:40 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20friedema?= =?UTF-8?q?nnsommer/lcov-parser@fd09739b565019bff8d304190f95d35de9887c14?= =?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 | 275 +++--------------- 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, 121 insertions(+), 300 deletions(-) diff --git a/development/classes/parser.LcovParser.html b/development/classes/parser.LcovParser.html index 0124f1ce..b80b32be 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'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

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 e4df7adb..cd9e59cb 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:

    @@ -201,128 +201,7 @@
  • resume
  • unpipe
    • -

Parameters

Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "data"
    • listener: ((chunk: any) => void)
        • (chunk): void

        • Parameters

          • chunk: any

          Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "drain"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "end"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "error"
    • listener: ((err: Error) => void)
        • (err): void

        • Parameters

          Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "finish"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "pause"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "pipe"
    • listener: ((src: Readable) => void)
        • (src): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "readable"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "resume"
    • listener: (() => void)
        • (): void

        • Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "unpipe"
    • listener: ((src: Readable) => void)
        • (src): void

        • Parameters

          • src: Readable

          Returns void

    Returns this

  • addListener(event, listener): this

  • Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: string | symbol
    • listener: ((...args: any[]) => void)
        • (...args): void

        • Parameters

          • Rest...args: any[]

          Returns void

    Returns this

    • asIndexedPairs

    asIndexedPairs

    eventNames

    eventNames

    every

    filter

    find

    flatMap

    forEach

    getMaxListeners

    isPaused

    iterator

    Returns AsyncIterator<any, any, any>

    Since

    v16.3.0

    listenerCount

    Returns number

    Since

    v3.2.0

    listeners

    map

    off

    on

    once

    pause

    pipe

    prependListener

    prependOnceListener

    push

    rawListeners

    read

    Returns any

    Since

    v0.9.4

    reduce

    removeAllListeners

    removeListener

    resume

    setDefaultEncoding

    Returns this

    Since

    v0.11.15

    setEncoding

    Returns this

    Since

    v0.9.4

    setMaxListeners

    some

    take

    toArray

    uncork

    unpipe

    Returns this

    Since

    v0.9.4

    unshift

    Returns void

    Since

    v0.9.11

    wrap

    Returns this

    Since

    v0.9.4

    write

    Returns boolean

    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

    -

    Since

    v0.9.4

    -
  • write(chunk, cb?): boolean

  • The writable.write() method writes some data to the stream, and calls the -supplied callback once the data has been fully handled. If an error -occurs, the callback will be called with the error as its -first argument. The callback is called asynchronously and before 'error' is -emitted.

    -

    The return value is true if the internal buffer is less than the highWaterMark configured when the stream was created after admitting chunk. -If false is returned, further attempts to write data to the stream should -stop until the 'drain' event is emitted.

    -

    While a stream is not draining, calls to write() will buffer chunk, and -return false. Once all currently buffered chunks are drained (accepted for -delivery by the operating system), the 'drain' event will be emitted. -Once write() returns false, do not write more chunks -until the 'drain' event is emitted. While calling write() on a stream that -is not draining is allowed, Node.js will buffer all written chunks until -maximum memory usage occurs, at which point it will abort unconditionally. -Even before it aborts, high memory usage will cause poor garbage collector -performance and high RSS (which is not typically released back to the system, -even after the memory is no longer required). Since TCP sockets may never -drain if the remote peer does not read the data, writing a socket that is -not draining may lead to a remotely exploitable vulnerability.

    -

    Writing data while the stream is not draining is particularly -problematic for a Transform, because the Transform streams are paused -by default until they are piped or a 'data' or 'readable' event handler -is added.

    -

    If the data to be written can be generated or fetched on demand, it is -recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is -possible to respect backpressure and avoid memory issues using the 'drain' event:

    -
    function write(data, cb) {
      if (!stream.write(data)) {
        stream.once('drain', cb);
      } else {
        process.nextTick(cb);
      }
    }

    // Wait for cb to be called before doing any other write.
    write('hello', () => {
      console.log('Write completed, do more writes now.');
    });
-
    - -

    A Writable stream in object mode will always ignore the encoding argument.

    -

    Parameters

    • chunk: any

      Optional data to write. For streams not operating in object mode, chunk must be a {string}, {Buffer}, -{TypedArray} or {DataView}. For object mode streams, chunk may be any JavaScript value other than null.

      -
    • Optionalcb: ((error: undefined | null | Error) => void)
        • (error): void

        • Parameters

          • error: undefined | null | Error

          Returns void

    Returns boolean

    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

    -

    Since

    v0.9.4

    -

    • StaticaddAbortListener

    StaticaddAbortListener

    Staticfrom

    StaticfromWeb

    StaticgetEventListeners

    StaticgetMaxListeners

    StaticisDisturbed

    StaticlistenerCount

    Returns number

    Since

    v0.9.12

    Deprecated

    Since v3.2.0 - Use listenerCount instead.

    Staticon

    Staticonce

    StaticsetMaxListeners

    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 5f6f29d4..2529ad5a 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 df3c5dc3..4a6a0654 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 a898c673..7871a072 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 b66feee2..9ca364b4 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 bdd5334e..9da691e1 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 cb7391d6..567fa49f 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 c603bea8..629ad8ac 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 ffb4620a..79b9ef4a 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 272d1f3b..690bb2dc 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 2fb3916d..c30efaa5 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 8837bdc0..dbd4d181 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 fo 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 b6a54ea8..242ffad4 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 6bde6d64..c71237c8 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 a9301c3c..8382b191 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 907c491a..9bb7b7ec 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 00074f3c..13a03402 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 610e923d..3bed9722 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 a21cbaf7..5669bd5f 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 8c08a87e..55158b76 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 14b7df66..8e2d371f 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 109fe9d2..b5a93a6c 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 70964518..805a3b16 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 3e1dc050..a19a67fd 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.

    -
    +