Class MigrationCategory

constructor

• new MigrationCategory(
      id: string,
      label: string,
      isNumber: boolean,
      state: MigrationState,
  ): MigrationCategory

  Parameters

  • id: string

    Category ID

  • label: string

    Label

  • isNumber: boolean

    Is numeric

  • state: MigrationState

    State tracker instance

  Returns MigrationCategory

completed

current

errors

id

ignored

invalid

isNumber

label

processed

state

total

currentName

• get currentName(): null | string

  Return name of currently processed entry.

  Returns null | string

  Remarks

  • Null if no entry is being processed currently.

hasTotal

• get hasTotal(): boolean

  Returns boolean

percentage

• get percentage(): number

  Returns number

progress

• get progress(): number

  Returns number

progressLabel

• get progressLabel(): string

  Returns string

addIgnored

• addIgnored(ignored: number): void

  Add unspecific ignored entries.

  Parameters

  • ignored: number

    Number of ignored entries

  Returns void

finish

• finish(): void

  Signal the finishing of processing this category.

  Returns void

finishEntry

• finishEntry(entry: any): void

  Signal that an entry has finished processing.

  Parameters

  • entry: any

    Whatever was finished processing with.

  Returns void

getErrorEntries

• getErrorEntries(): any[]

  Returns any[]

getInvalidEntries

• getInvalidEntries(): { entry: Invalid; id: string }[]

  Returns { entry: Invalid; id: string }[]

ignoreEntry

• ignoreEntry(entry: any): void

  Signal that a specific entry was ignored.

  Parameters

  • entry: any

    Whatever was ignored.

  Returns void

recordError

• recordError(entry: any, error: any): void

  Parameters

  • entry: any
  • error: any

  Returns void

setInvalid

• setInvalid(total: number): void

  Record total number of invalid items in this category.

  Parameters

  • total: number

    Total number of invalid entries in the category

  Returns void

setProgress

• setProgress(value: any): void

  Parameters

  • value: any

  Returns void

setTotal

• setTotal(total: number): void

  Record total number of items in this category.

  Parameters

  • total: number

    Total number of entries in category

  Returns void

start

• start(): void

  Signal the start of processing this category.

  Returns void

startEntry

• startEntry(entry: any): void

  Signal that an entry has started processing.

  Parameters

  • entry: any

    Whatever was started processing.

  Returns void