Interface: SkinModule

Defined in: src/skins.ts:395

import type { SkinModule } from 'osu-files'

return db.skins.get.first()?.Name

Properties

get

readonly get: Skins

Defined in: src/skins.ts:397

Returns read-only skin snapshots through get.

---

write

readonly write: Crud<Skin>

Defined in: src/skins.ts:399

Creates, updates, deletes, or upserts skins.

Methods

delete()

delete(skinId): void

Defined in: src/skins.ts:413

Marks a skin for deletion.

Parameters

Parameter	Type
skinId	string

Returns

void

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

duplicate()

duplicate(skinId): Skin

Defined in: src/skins.ts:417

Copies a skin with a new ID and name.

Parameters

Parameter	Type
skinId	string

Returns

Skin

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

editIni()

editIni(skinId, edit): boolean

Defined in: src/skins.ts:407

Edits a skin.ini file.

Parameters

Parameter	Type
skinId	string
edit	(document) => void

Returns

boolean

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

exportOsk()

exportOsk(skinId): Promise<Buffer<ArrayBufferLike>>

Defined in: src/skins.ts:411

Exports a skin as an .osk archive.

Parameters

Parameter	Type
skinId	string

Returns

Promise<Buffer<ArrayBufferLike>>

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

importOsk()

importOsk(filePath): Promise<ImportedSkinData>

Defined in: src/skins.ts:409

Imports an .osk archive.

Parameters

Parameter	Type
filePath	string

Returns

Promise<ImportedSkinData>

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

open()

open(skinId): SkinEditor

Defined in: src/skins.ts:401

Opens one skin editor.

Parameters

Parameter	Type
skinId	string

Returns

SkinEditor

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

readIni()

readIni(skinId): SkinIniDocument | undefined

Defined in: src/skins.ts:403

Reads a skin.ini file.

Parameters

Parameter	Type
skinId	string

Returns

SkinIniDocument | undefined

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

replaceIni()

replaceIni(skinId, source): boolean

Defined in: src/skins.ts:405

Replaces a skin.ini file.

Parameters

Parameter	Type
skinId	string
source	string | SkinIniDocument

Returns

boolean

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined

---

undelete()

undelete(skinId): void

Defined in: src/skins.ts:415

Clears a skin's delete flag.

Parameters

Parameter	Type
skinId	string

Returns

void

This example requires Node.js.

import { SkinModule } from 'osu-files'

return undefined