Interface: BeatmapSetModule

Defined in: src/sets.ts:203

import type { BeatmapSetModule } from 'osu-files'

return db.sets.get.first()?.OnlineID

Properties

get

readonly get: Sets

Defined in: src/sets.ts:205

Returns read-only beatmap-set snapshots through get.

---

write

readonly write: Crud<BeatmapSet>

Defined in: src/sets.ts:207

Creates, updates, deletes, or upserts beatmap sets.

Methods

addFile()

addFile(setId, filename, content): FileRef

Defined in: src/sets.ts:215

Adds a file and updates the set hash.

Parameters

Parameter	Type
setId	string
filename	string
content	Buffer

Returns

FileRef

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined

---

delete()

delete(setId): void

Defined in: src/sets.ts:213

Marks a beatmap set for deletion.

Parameters

Parameter	Type
setId	string

Returns

void

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined

---

getFileRefs()

getFileRefs(setId): FileRef[]

Defined in: src/sets.ts:217

Returns file references owned by the set.

Parameters

Parameter	Type
setId	string

Returns

FileRef[]

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined

---

getFileRefsWithContent()

getFileRefsWithContent(setId): FileRef[]

Defined in: src/sets.ts:219

Returns file references with file content when available.

Parameters

Parameter	Type
setId	string

Returns

FileRef[]

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined

---

importSet()

importSet(data): BeatmapSetData

Defined in: src/sets.ts:211

Imports beatmap-set data.

Parameters

Parameter	Type
data	ImportSetInput

Returns

BeatmapSetData

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined

---

open()

open(setId): BeatmapSetEditor

Defined in: src/sets.ts:209

Opens one beatmap-set editor.

Parameters

Parameter	Type
setId	string

Returns

BeatmapSetEditor

This example requires Node.js.

import { BeatmapSetModule } from 'osu-files'

return undefined