Type Alias: RulesetSettingModule

RulesetSettingModule = object

Defined in: src/rulesetsettings.ts:73

import type { RulesetSettingModule } from 'osu-files'

return db.rulesetSettings.get.first()?.Value

Properties

get

readonly get: RulesetSettings

Defined in: src/rulesetsettings.ts:75

Returns read-only ruleset settings through get.

Methods

getSettings()

getSettings(rulesetName, variant?): Record<string, string>

Defined in: src/rulesetsettings.ts:77

Returns settings for one ruleset and variant.

Parameters

Parameter	Type
rulesetName	RulesetShortName
variant?	number

Returns

Record<string, string>

This example requires Node.js.

import { RulesetSettingModule } from 'osu-files'

return undefined

---

removeSetting()

removeSetting(rulesetName, key, variant?): void

Defined in: src/rulesetsettings.ts:81

Removes one ruleset setting.

Parameters

Parameter	Type
rulesetName	RulesetShortName
key	string
variant?	number

Returns

void

This example requires Node.js.

import { RulesetSettingModule } from 'osu-files'

return undefined

---

setSetting()

setSetting(rulesetName, key, value, variant?): void

Defined in: src/rulesetsettings.ts:79

Sets one ruleset setting.

Parameters

Parameter	Type
rulesetName	RulesetShortName
key	string
value	string
variant?	number

Returns

void

This example requires Node.js.

import { RulesetSettingModule } from 'osu-files'

return undefined