Type Alias AmConfig

Type declaration

• createConfigEntityExportTemplate:function

  • createConfigEntityExportTemplate(
        realms?: string[],
    ): Promise<ConfigEntityExportInterface>

    Create an empty config entity export template

    Parameters

    • Optionalrealms: string[]

    Returns Promise<ConfigEntityExportInterface>

    an empty config entity export template

• exportAmConfigEntities:function

  • exportAmConfigEntities(
        includeReadOnly: boolean,
        onlyRealm: boolean,
        onlyGlobal: boolean,
        resultCallback?: ResultCallback<AmConfigEntityInterface>,
    ): Promise<ConfigEntityExportInterface>

    Export all other AM config entities

    Parameters

    • includeReadOnly: boolean

      Include read only config in the export
    • onlyRealm: boolean

      Export config only from the active realm. If onlyGlobal is also active, then it will also export the global config.
    • onlyGlobal: boolean

      Export global config only. If onlyRealm is also active, then it will also export the active realm config.
    • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

      Optional callback to process individual results

    Returns Promise<ConfigEntityExportInterface>

    promise resolving to a ConfigEntityExportInterface object

• importAmConfigEntities:function

  • importAmConfigEntities(
        importData: ConfigEntityExportInterface,
        resultCallback?: ResultCallback<AmConfigEntityInterface>,
    ): Promise<ConfigSkeleton>

    Import all other AM config entities

    Parameters

    • importData: ConfigEntityExportInterface

      The config import data
    • OptionalresultCallback: ResultCallback<AmConfigEntityInterface>

      Optional callback to process individual results

    Returns Promise<ConfigSkeleton>

    a promise that resolves to a config object containing global and realm config entities, or null if no import was performed