Class OutputSettings

[[Output]] production parameters. OutputSettings provide contextual configuration parameters to output producers, such as [[Writer Writers]]. Uses include enabling pretty printing and styling generated output. Subclasses can provide additional parameters understood by specialized output producers.

Hierarchy

OutputSettings

Implements

Debug
HashCode

Index

Constructors

`Protected` constructor

new OutputSettings(lineSeparator, pretty, styled, precision): OutputSettings
Parameters
- lineSeparator: string
- pretty: boolean
- styled: boolean
- precision: number
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:29

Properties

`Readonly` lineSeparator

lineSeparator: string

The Unicode code point sequence used to separate lines of text. Defaults to the runtime operating system's line separator.

`Readonly` precision

precision: number

Returns the numeric precision output producers should use when formatting numbers.

Methods

asPretty

asPretty(pretty): OutputSettings
Returns a copy of these settings with the given pretty flag.
Parameters
- pretty: boolean
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:49

asStyled

asStyled(styled): OutputSettings
Returns a copy of these settings with the given styled flag.
Parameters
- styled: boolean
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:60

`Protected` canEqual

canEqual(that): boolean
Parameters
- that: unknown
Returns boolean
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:71

`Protected` copy

copy(lineSeparator, pretty, styled, precision): OutputSettings
Parameters
- lineSeparator: string
- pretty: boolean
- styled: boolean
- precision: number
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:70

debug

debug<T>(output): Output<T>
Writes a developer readable, debug-formatted string representation of this object to output.
Type Parameters
- T
Parameters
- output: Output<T>
Returns Output<T>
the continuation of the output.

Throws
[[OutputException]] if the output exits the cont state before the full debug string has been written.
Implementation of Debug.debug
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:74

equals

equals(that): boolean
Parameters
- that: unknown
Returns boolean
Implementation of HashCode.equals
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:72

hashCode

hashCode(): number
Returns number
Implementation of HashCode.hashCode
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:73

isPretty

isPretty(): boolean
Returns true if output producers should pretty print their output, when possible.

Returns boolean
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:45

isStyled

isStyled(): boolean
Returns true if output producers should style their output, when possible.

Returns boolean
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:56

toString

toString(): string
Returns string
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:75

withLineSeparator

withLineSeparator(lineSeparator): string | OutputSettings
Returns a copy of these settings with the given lineSeparator.
Parameters
- lineSeparator: string
Returns string | OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:38

withPrecision

withPrecision(precision): OutputSettings
Returns a copy of these settings with the given numeric precision.
Parameters
- precision: number
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:69

`Static` create

create(lineSeparator?, pretty?, styled?, precision?): OutputSettings
Returns OutputSettings configured with the given lineSeparator, pretty printing enabled if isPretty is true, styling enabled if isStyled is true, and with the given numeric precision.
Parameters
- Optional lineSeparator: string
- Optional pretty: boolean
- Optional styled: boolean
- Optional precision: number
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:101

`Static` fromInit

fromInit(init): OutputSettings
Converts a settings init object to an instance of OutputSettings.
Parameters
- init: OutputSettingsInit
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:105

`Static` fromLike

fromLike(value): OutputSettings
Converts a loosely typed settings value to an instance of OutputSettings.
Parameters
- value: OutputSettingsLike
Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:109

`Static` pretty

pretty(): OutputSettings
Returns OutputSettings configured with the system line separator, pretty printing enabled, and styling disabled.

Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:85

`Static` prettyStyled

prettyStyled(): OutputSettings
Returns OutputSettings configured with the system line separator, pretty printing enabled, and styling enabled.

Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:95

`Static` standard

standard(): OutputSettings
Returns OutputSettings configured with the system line separator, pretty printing disabled, and styling disabled.

Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:80

`Static` styled

styled(): OutputSettings
Returns OutputSettings configured with the system line separator, pretty printing disabled, and styling enabled.

Returns OutputSettings
- Defined in swim-core/swim-codec/lib/main/output/OutputSettings.d.ts:90

Class OutputSettings

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Parameters

lineSeparator: string

pretty: boolean

styled: boolean

precision: number

Returns OutputSettings

Properties

Readonly lineSeparator

Readonly precision

Methods

asPretty

Parameters

pretty: boolean

Returns OutputSettings

asStyled

Parameters

styled: boolean

Returns OutputSettings

Protected canEqual

Parameters

that: unknown

Returns boolean

Protected copy

Parameters

lineSeparator: string

pretty: boolean

styled: boolean

precision: number

Returns OutputSettings

debug

Type Parameters

T

Parameters

output: Output<T>

Returns Output<T>

Throws

equals

Parameters

that: unknown

Returns boolean

hashCode

Returns number

isPretty

Returns boolean

isStyled

Returns boolean

toString

Returns string

withLineSeparator

Parameters

lineSeparator: string

Returns string | OutputSettings

withPrecision

Parameters

precision: number

Returns OutputSettings

Static create

Parameters

Optional lineSeparator: string

Optional pretty: boolean

Optional styled: boolean

Optional precision: number

Returns OutputSettings

Static fromInit

Parameters

init: OutputSettingsInit

Returns OutputSettings

Static fromLike

Parameters

value: OutputSettingsLike

Returns OutputSettings

`Protected` constructor

`Readonly` lineSeparator

`Readonly` precision

`Protected` canEqual

`Protected` copy

`Static` create

`Optional` lineSeparator: string

`Optional` pretty: boolean

`Optional` styled: boolean

`Optional` precision: number

`Static` fromInit

`Static` fromLike

`Static` pretty

`Static` prettyStyled

`Static` standard

`Static` styled