Interface Beautifier

Beautifier

Hierarchy

Beautifier

Index

Properties

Methods

Properties

Optional badges

badges: Badge[]

Badges to display in automatically generated documentation.

Optional dependencies

dependencies: DependencyDefinition[]

Runtime dependencies of the beautifier.

name

name: BeautifierName

Unique identifying name of the beautifier.

options

options: BeautifierOptions

Supports options of the beautifier.

Optional package

package: undefined | object

Parsed Package.json file as JSON.

Methods

beautify

beautify(data: BeautifierBeautifyData): Promise<string>

- Defined in src/beautifier.ts:178
Beautify the given code with the beautifier.

Parameters
- data: BeautifierBeautifyData
Returns Promise<string>

Optional resolveConfig

resolveConfig(resolveConfigData: ResolveConfigData): Promise<ResolvedConfig>

- Defined in src/beautifier.ts:174
Function to retrieve beautifier-specific configuration file and/or parsed value.

Parameters
- resolveConfigData: ResolveConfigData
Returns Promise<ResolvedConfig>

Generated using TypeDoc