Class ImportSeparator

Class to insert the separators into the imports.

Hierarchy

ImportSeparator

Index

Constructors

constructor

Methods

Properties

separateByRules

Constructors

constructor

new ImportSeparator(separateByRules: string[]): ImportSeparator
new ImportSeparator(separateByRules: string[], requireFunctions: Record<string, SeparateByFunction>): ImportSeparator

- Defined in src/import_management/ImportSeparator.ts:20
Constructor with only separate by rules.

Parameters
- separateByRules: string[]
  
  Array of separate by rules
Returns ImportSeparator
- Defined in src/import_management/ImportSeparator.ts:26
Constructor including external functions.

Parameters
- separateByRules: string[]
  
  Array of separate by rules
- requireFunctions: Record<string, SeparateByFunction>
  
  Record of external functions by their function name
Returns ImportSeparator

Methods

Private decideSeparator

decideSeparator(a: undefined | null | Import, b: undefined | null | Import): boolean

- Defined in src/import_management/ImportSeparator.ts:62
Given two imports, this will decide if a separator should be placed in between according to the separate by rules.

If at least one of them is not an import no more separator are needed.

Parameters
- a: undefined | null | Import
  
  Import A
- b: undefined | null | Import
  
  Import B
Returns boolean

insertSeparator

insertSeparator(imports: Import[]): (null | Import)[]

- Defined in src/import_management/ImportSeparator.ts:79
Inserts the null elements as separator in an array of imports.

Parameters
- imports: Import[]
  
  Array of imports to insert the separator
Returns (null | Import)[]

Properties

Readonly separateByRules

separateByRules: SeparateByFunction[] = []

Array of separate by rules. Order is not relevant.

Generated using TypeDoc