Type Alias: SkinEditor

SkinEditor = object

Defined in: src/skins.ts:32

This example requires Node.js.

import type { SkinEditor } from 'osu-files'

const value = {} as SkinEditor
return value

Properties

id

readonly id: string

Defined in: src/skins.ts:34

Skin UUID.

---

value

readonly value: SkinSnapshot

Defined in: src/skins.ts:36

Detached skin snapshot.

Methods

contentHash()

contentHash(): string

Defined in: src/skins.ts:46

Computes a non-persisted hash over every referenced skin file.

Returns

string

This example requires Node.js.

import { SkinEditor } from 'osu-files'

return undefined

---

editIni()

editIni(edit): Promise<boolean>

Defined in: src/skins.ts:44

Applies edits to a cloned skin.ini document.

Parameters

Parameter	Type
edit	(document) => void

Returns

Promise<boolean>

This example requires Node.js.

import { SkinEditor } from 'osu-files'

return undefined

---

getFile()

getFile(filename): OwnedFileEditor

Defined in: src/skins.ts:38

Opens one owner-scoped file editor.

Parameters

Parameter	Type
filename	string

Returns

OwnedFileEditor

This example requires Node.js.

import { SkinEditor } from 'osu-files'

return undefined

---

readIni()

readIni(): SkinIniDocument | undefined

Defined in: src/skins.ts:40

Reads this skin's skin.ini, if present.

Returns

SkinIniDocument | undefined

This example requires Node.js.

import { SkinEditor } from 'osu-files'

return undefined

---

replaceIni()

replaceIni(source): Promise<boolean>

Defined in: src/skins.ts:42

Replaces this skin's skin.ini atomically.

Parameters

Parameter	Type
source	string | SkinIniDocument

Returns

Promise<boolean>

This example requires Node.js.

import { SkinEditor } from 'osu-files'

return undefined