BSB Node.js Type Definitions
    Preparing search index...

    Type Alias BSBConfigMigration<T>

    BSBConfigMigration: (
        versionFrom: string | null,
        versionTo: string,
        existingConfig?: z.infer<Exclude<T, undefined>>,
    ) => Promise<z.infer<Exclude<T, undefined>>>

    Config migration handler, allows for config migrations when the plugin version changes or a new plugin setup is done

    Type Parameters

    Type Declaration

      • (
            versionFrom: string | null,
            versionTo: string,
            existingConfig?: z.infer<Exclude<T, undefined>>,
        ): Promise<z.infer<Exclude<T, undefined>>>

      • Parameters

        • versionFrom: string | null
        • versionTo: string
        • OptionalexistingConfig: z.infer<Exclude<T, undefined>>

        Returns Promise<z.infer<Exclude<T, undefined>>>

    simple version change and basic setup
    const configMigration = async (versionFrom: string | null, versionTo: string, existingConfig?: z.infer<BSBConfigDefinition>) => {
    if (versionFrom === null) {
     return {
      a: "a",
     };
    }
    return {
     a: "b",
    };

    basic setup and no version change handling
    const configMigration = async (versionFrom: string | null, versionTo: string, existingConfig?: z.infer<BSBConfigDefinition>) => {
    if (versionFrom === null || existingConfig === undefined) {
     return {
      a: "a",
     };
    }
    return existingConfig;

    Settings

    Member Visibility