Interface LDMigration<TMigrationRead, TMigrationWrite, TMigrationReadInput, TMigrationWriteInput>

Interface representing a migration.

Type Parameters

  • TMigrationRead

  • TMigrationWrite

  • TMigrationReadInput = any

  • TMigrationWriteInput = any

Hierarchy

  • LDMigration

Methods

Methods

  • Perform a read using the migration.

    Parameters

    • key: string

      The key of the flag controlling the migration.

    • context: LDContext

      The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

    • defaultValue: LDMigrationStage

      The default migration step. Used if the value is not available from LaunchDarkly.

    • Optional payload: TMigrationReadInput
      Optional

    Returns Promise<LDMigrationReadResult<TMigrationRead>>

  • Perform a write using the migration.

    Parameters

    • key: string

      The key of the flag controlling the migration.

    • context: LDContext

      The context requesting the flag. The client will generate an analytics event to register this context with LaunchDarkly if the context does not already exist.

    • defaultValue: LDMigrationStage

      The default migration step. Used if the value is not available from LaunchDarkly.

    • Optional payload: TMigrationWriteInput
      Optional

    Returns Promise<LDMigrationWriteResult<TMigrationWrite>>

Generated using TypeDoc