メインコンテンツまでスキップ
バージョン: v2.0

updateOptions()

この関数は、XP Client のオプションを更新するために使用します。

xp_rate を指定する場合は、"slow"、"normal"、"fast" のいずれか、または 0 より大きい有限数である必要があります。

備考

MongoDB では、内部処理で使用するデータベース名を明示するために dbOptions.name を渡せます。

パラメーター​

ParameterTypeRequiredDescription
clientOptionsNewClientOptions✅更新するオプション。

戻り値​

  • Promise<void>

例外​

  • XpFatal - 無効なパラメーターが渡された場合、または無効なデータベース接続が渡された場合。

[JS] 例​

const { updateOptions } = require("simply-xp");

(async () => {
        await updateOptions({ xp_rate: "fast" }); // Returns Promise<void>

        await updateOptions({
                dbOptions: {
                        type: "mongodb",
                        database: mongoClient,
                        name: "my-custom-db",
                },
        });
})();