Skip to content

RulesetSettings ​

db.rulesetSettings.get returns read-only snapshots for ruleset settings. You can keep chaining filters or use normal array methods.

These examples use a small fixture that resets for every run. Your application still uses its own Realm database.

all ​

Returns all matching ruleset settings in a regular array.

ts
return db.rulesetSettings.get
  .all()
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

toArray ​

Returns all matching ruleset settings in a regular array.

ts
return db.rulesetSettings.get
  .toArray()
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

first ​

Returns the first matching ruleset setting, or undefined.

ts
return db.rulesetSettings.get
  .first()?.Key

count ​

Counts all matching ruleset settings, even when a limit is set.

ts
return db.rulesetSettings.get
  .count()

limit ​

Limits how many ruleset settings elements are accessed.

ts
return db.rulesetSettings.get
  .limit(1)
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

sortedBy ​

Sorts ruleset settings by a database field.

ts
return db.rulesetSettings.get
  .sortedBy('Key')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byKey ​

Finds ruleset settings where key matches the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byKey('BeatmapListing')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byKeyContains ​

Finds ruleset settings where key contains the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byKeyContains('Beatmap')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byRulesetName ​

Finds ruleset settings where ruleset name matches the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byRulesetName('osu')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byValue ​

Finds ruleset settings where value matches the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byValue('1')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byValueContains ​

Finds ruleset settings where value contains the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byValueContains('enabled')
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

byVariant ​

Finds ruleset settings where variant matches the supplied value. You can chain more filters on the result.

ts
return db.rulesetSettings.get
  .byVariant(0)
  .map(item => ({
    key: item.Key,
    value: item.Value,
  }))

Released under the MIT License.