Skip to Content
🎉 New release with new features and improvements! V0.0.2 Release →

Settings Service

The Settings Service provides methods for retrieving and updating application configuration settings.

Methods

load

Retrieves the current application configuration settings.

await bshEngine.settings.load();

update

Updates application configuration settings.

await bshEngine.settings.update({ payload: { api: { auth: { enableRegister: true }, response: { showSql: false } } } });
PropertyTypeRequiredDescription
apiobjectyesAPI configuration settings
api.authobjectyesAuthentication configuration
api.auth.enableRegisterbooleanyesWhether to enable the register feature
api.responseobjectyesResponse configuration
api.response.showSqlbooleanyesWhether to show SQL queries in responses