Class InputSettings

Input consumption parameters. InputSettings provide contextual configuration parameters to input consumers, such as Parsers.

Hierarchy

InputSettings

Implements

Index

Constructors

constructor

Methods

Constructors

Protected constructor

new InputSettings(isStripped: boolean): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:36
Parameters
- isStripped: boolean
Returns InputSettings

Methods

Protected canEqual

canEqual(that: unknown): boolean

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:65
Parameters
- that: unknown
Returns boolean

Protected copy

copy(isStripped: boolean): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:61
Parameters
- isStripped: boolean
Returns InputSettings

debug

debug(output: Output): void

Implementation of Debug.debug
- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:86
Parameters
- output: Output
Returns void

equals

equals(that: unknown): boolean

Implementation of HashCode.equals
- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:69
Parameters
- that: unknown
Returns boolean

hashCode

hashCode(): number

Implementation of HashCode.hashCode
- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:78
Returns number

isStripped

isStripped(): boolean
isStripped(isStripped: boolean): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:46
Returns true if input consumers should not include diagnostic metadata in generated output.

Returns boolean
- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:51
Returns a copy of these settings with the given isStripped flag.

Parameters
- isStripped: boolean
Returns InputSettings

toString

toString(): string

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:96
Returns string

Static create

create(isStripped?: undefined | false | true): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:130
Returns InputSettings configured to not include diagnostic metadata in generated output, if isStripped is true.

Parameters
- Optional isStripped: undefined | false | true
Returns InputSettings

Static fromAny

fromAny(settings: AnyInputSettings | undefined): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:140
Converts the loosely typed settings to an instance of InputSettings.

Parameters
- settings: AnyInputSettings | undefined
Returns InputSettings

Static standard

standard(): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:108
Returns InputSettings configured to include diagnostic metadata in generated output.

Returns InputSettings

Static stripped

stripped(): InputSettings

- Defined in swim-core-js/@swim/codec/main/InputSettings.ts:119
Returns InputSettings configured to not include diagnostic metadata in generated output.

Returns InputSettings