Skip to main content
Go to Latest
function compat.migrations.updateConfig
import { compat } from "https://deno.land/x/embassyd_sdk@v0.334.0-alpha4/mod.ts";
const { updateConfig } = compat.migrations;

Type Parameters

version extends string
type extends "up" | "down"

Parameters

fn: (config: ConfigSpec, effects: T.Effects) => ConfigSpec | Promise<ConfigSpec>

function making desired modifications to the config

configured: boolean

whether or not the service should be considered "configured"

optional
noRepeat: NoRepeat<version, type>

(optional) supply the version and type of the migration

optional
noFail = [UNSUPPORTED]

(optional, default:false) whether or not to fail the migration if fn throws an error

Returns

M.MigrationFn<version, type>

a migraion function