Interface LDMigration<TMigrationRead, TMigrationWrite, TMigrationReadInput, TMigrationWriteInput>

Interface representing a migration.

interface LDMigration<
    TMigrationRead,
    TMigrationWrite,
    TMigrationReadInput = any,
    TMigrationWriteInput = any,
> {
    read(
        key: string,
        context: LDContext,
        defaultValue: LDMigrationStage,
        payload?: TMigrationReadInput,
    ): Promise<LDMigrationReadResult<TMigrationRead>>;
    write(
        key: string,
        context: LDContext,
        defaultValue: LDMigrationStage,
        payload?: TMigrationWriteInput,
    ): Promise<LDMigrationWriteResult<TMigrationWrite>>;
}

Type Parameters

TMigrationRead
TMigrationWrite
TMigrationReadInput = any
TMigrationWriteInput = any

Index

Methods

Methods

read

read(
    key: string,
    context: LDContext,
    defaultValue: LDMigrationStage,
    payload?: TMigrationReadInput,
): Promise<LDMigrationReadResult<TMigrationRead>>
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.
- Optionalpayload: TMigrationReadInput
Returns Promise<LDMigrationReadResult<TMigrationRead>>
- Defined in packages/shared/sdk-server/src/api/LDMigration.ts:71

write

write(
    key: string,
    context: LDContext,
    defaultValue: LDMigrationStage,
    payload?: TMigrationWriteInput,
): Promise<LDMigrationWriteResult<TMigrationWrite>>
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.
- Optionalpayload: TMigrationWriteInput
Returns Promise<LDMigrationWriteResult<TMigrationWrite>>
- Defined in packages/shared/sdk-server/src/api/LDMigration.ts:87