formatUtils

Index

Enumerations

• LogLevel
• Style

Type Aliases

• Field
• Source
• Tuple
• Type

Variables

• Type
• supportsColor
• supportsHyperlinks

Functions

• addLogFilterSupport
• applyColor
• applyHyperlink
• applyStyle
• json
• jsonOrPretty
• mark
• pretty
• prettyField
• prettyList
• prettyTruncatedLocatorList
• tuple

Enumerations

LogLevel

LogLevel:

Discard

Discard: discard

Error

Error: error

Info

Info: info

Warning

Warning: warning

Style

Style:

BOLD

BOLD: 2

Type Aliases

Field

Field: { label: string; value: Tuple<any> }

Type declaration

• label: string

• value: Tuple<any>

Source

Source<T>: T extends keyof AllTransforms ? Parameters<AllTransforms[T][json]>[0] | null : string | null

Type parameters

• T

Tuple

Tuple<T>: readonly [Source<T>, T]

Type parameters

• T: Type = Type

Type

Type: keyof typeof Type

Variables

constType

Type: { ADDED: ADDED; CODE: CODE; DEPENDENT: DEPENDENT; DESCRIPTOR: DESCRIPTOR; DURATION: DURATION; ID: ID; IDENT: IDENT; INSPECT: INSPECT; LOCATOR: LOCATOR; MARKDOWN: MARKDOWN; MARKDOWN_INLINE: MARKDOWN_INLINE; NAME: NAME; NO_HINT: NO_HINT; NULL: NULL; NUMBER: NUMBER; PACKAGE_EXTENSION: PACKAGE_EXTENSION; PATH: PATH; RANGE: RANGE; REFERENCE: REFERENCE; REMOVED: REMOVED; RESOLUTION: RESOLUTION; SCOPE: SCOPE; SETTING: SETTING; SIZE: SIZE; SIZE_DIFF: SIZE_DIFF; URL: URL } = ...

Type declaration

• readonlyADDED: ADDED

• readonlyCODE: CODE

• readonlyDEPENDENT: DEPENDENT

• readonlyDESCRIPTOR: DESCRIPTOR

• readonlyDURATION: DURATION

• readonlyID: ID

• readonlyIDENT: IDENT

• readonlyINSPECT: INSPECT

• readonlyLOCATOR: LOCATOR

• readonlyMARKDOWN: MARKDOWN

• readonlyMARKDOWN_INLINE: MARKDOWN_INLINE

• readonlyNAME: NAME

• readonlyNO_HINT: NO_HINT

• readonlyNULL: NULL

• readonlyNUMBER: NUMBER

• readonlyPACKAGE_EXTENSION: PACKAGE_EXTENSION

• readonlyPATH: PATH

• readonlyRANGE: RANGE

• readonlyREFERENCE: REFERENCE

• readonlyREMOVED: REMOVED

• readonlyRESOLUTION: RESOLUTION

• readonlySCOPE: SCOPE

• readonlySETTING: SETTING

• readonlySIZE: SIZE

• readonlySIZE_DIFF: SIZE_DIFF

• readonlyURL: URL

constsupportsColor

supportsColor: boolean = ...

constsupportsHyperlinks

supportsHyperlinks: boolean = ...

Functions

addLogFilterSupport

• addLogFilterSupport(report: Report, __namedParameters: { configuration: Configuration }): void

• Add support support for the logFilters setting to the specified Report instance.

  ---

  Parameters

  • report: Report

  • __namedParameters: { configuration: Configuration }

  Returns void

applyColor

• applyColor(configuration: Configuration, value: string, formatType: string): string

• Parameters

  • configuration: Configuration

  • value: string

  • formatType: string

  Returns string

applyHyperlink

• applyHyperlink(configuration: Configuration, text: string, href: string): string

• Parameters

  • configuration: Configuration

  • text: string

  • href: string

  Returns string

applyStyle

• applyStyle(configuration: Configuration, text: string, flags: BOLD): string

• Parameters

  • configuration: Configuration

  • text: string

  • flags: BOLD

  Returns string

json

• json<T>(value: Source<T>, formatType: string | T): any

• Type parameters

  • T: NO_HINT | ID | NULL | SCOPE | NAME | RANGE | REFERENCE | NUMBER | PATH | URL | ADDED | REMOVED | CODE | INSPECT | DURATION | SIZE | SIZE_DIFF | IDENT | DESCRIPTOR | LOCATOR | RESOLUTION | DEPENDENT | PACKAGE_EXTENSION | SETTING | MARKDOWN | MARKDOWN_INLINE

  Parameters

  • value: Source<T>

  • formatType: string | T

  Returns any

jsonOrPretty

• jsonOrPretty<T>(outputJson: boolean, configuration: Configuration, __namedParameters: Tuple<T>): any

• Type parameters

  • T: NO_HINT | ID | NULL | SCOPE | NAME | RANGE | REFERENCE | NUMBER | PATH | URL | ADDED | REMOVED | CODE | INSPECT | DURATION | SIZE | SIZE_DIFF | IDENT | DESCRIPTOR | LOCATOR | RESOLUTION | DEPENDENT | PACKAGE_EXTENSION | SETTING | MARKDOWN | MARKDOWN_INLINE

  Parameters

  • outputJson: boolean

  • configuration: Configuration

  • __namedParameters: Tuple<T>

  Returns any

mark

• mark(configuration: Configuration): { Check: string; Cross: string; Question: string }

• Parameters

  • configuration: Configuration

  Returns { Check: string; Cross: string; Question: string }

  • Check: string

  • Cross: string

  • Question: string

pretty

• pretty<T>(configuration: Configuration, value: Source<T>, formatType: string | T): string

• Type parameters

  • T: NO_HINT | ID | NULL | SCOPE | NAME | RANGE | REFERENCE | NUMBER | PATH | URL | ADDED | REMOVED | CODE | INSPECT | DURATION | SIZE | SIZE_DIFF | IDENT | DESCRIPTOR | LOCATOR | RESOLUTION | DEPENDENT | PACKAGE_EXTENSION | SETTING | MARKDOWN | MARKDOWN_INLINE

  Parameters

  • configuration: Configuration

  • value: Source<T>

  • formatType: string | T

  Returns string

prettyField

• prettyField(configuration: Configuration, __namedParameters: Field): string

• Parameters

  • configuration: Configuration

  • __namedParameters: Field

  Returns string

prettyList

• prettyList<T>(configuration: Configuration, values: Iterable<Source<T>>, formatType: string | T, __namedParameters?: { separator?: string }): string

• Type parameters

  • T: NO_HINT | ID | NULL | SCOPE | NAME | RANGE | REFERENCE | NUMBER | PATH | URL | ADDED | REMOVED | CODE | INSPECT | DURATION | SIZE | SIZE_DIFF | IDENT | DESCRIPTOR | LOCATOR | RESOLUTION | DEPENDENT | PACKAGE_EXTENSION | SETTING | MARKDOWN | MARKDOWN_INLINE

  Parameters

  • configuration: Configuration

  • values: Iterable<Source<T>>

  • formatType: string | T

  • __namedParameters: { separator?: string } = {}

  Returns string

prettyTruncatedLocatorList

• prettyTruncatedLocatorList(configuration: Configuration, locators: Locator[], recommendedLength: number): string

• Parameters

  • configuration: Configuration

  • locators: Locator[]

  • recommendedLength: number

  Returns string

tuple

• tuple<T>(formatType: T, value: Source<T>): Tuple<T>

• Type parameters

  • T: NO_HINT | ID | NULL | SCOPE | NAME | RANGE | REFERENCE | NUMBER | PATH | URL | ADDED | REMOVED | CODE | INSPECT | DURATION | SIZE | SIZE_DIFF | IDENT | DESCRIPTOR | LOCATOR | RESOLUTION | DEPENDENT | PACKAGE_EXTENSION | SETTING | MARKDOWN | MARKDOWN_INLINE

  Parameters

  • formatType: T

  • value: Source<T>

  Returns Tuple<T>