Class RestMigrator<Source, Target, SourceOption>

constructor

• new RestMigrator<
      Source extends object,
      Target extends DataObject,
      SourceOption extends object | undefined = {},
  >(
      dataSource: (
          option?: SourceOption,
      ) => Iterable<Source, any, any> | AsyncIterable<Source, any, any>,
      TargetModel: Constructor<ListModel<Target, Partial<NewData<Target>>>>,
      fieldMapping: MigrationSchema<Source, Target>,
      eventBus?: MigrationEventBus<Source, Target>,
  ): RestMigrator<Source, Target, SourceOption>

  Type Parameters

  • Source extends object
  • Target extends DataObject
  • SourceOption extends object | undefined = {}

  Parameters

  • dataSource: (
        option?: SourceOption,
    ) => Iterable<Source, any, any> | AsyncIterable<Source, any, any>
  • TargetModel: Constructor<ListModel<Target, Partial<NewData<Target>>>>
  • fieldMapping: MigrationSchema<Source, Target>
  • eventBus: MigrationEventBus<Source, Target> = ...

  Returns RestMigrator<Source, Target, SourceOption>

dryRun

boot

• boot(
      __namedParameters?: BootOption<SourceOption>,
  ): AsyncGenerator<Target, void, unknown>

  Main migration method that yields progress information

  Parameters

  • __namedParameters: BootOption<SourceOption> = {}

  Returns AsyncGenerator<Target, void, unknown>