Type Alias: SkinIniDocument

SkinIniDocument = object

Defined in: src/skin/skin-ini.ts:140

Lossless parsed skin.ini document with typed projections for known settings.

import { parseSkinIni } from 'osu-files'

return parseSkinIni(skinIniSource)

Properties

catchTheBeat

catchTheBeat: SkinIniCatchTheBeat

Defined in: src/skin/skin-ini.ts:148

---

colours

colours: SkinIniColours

Defined in: src/skin/skin-ini.ts:146

---

fonts

fonts: SkinIniFonts

Defined in: src/skin/skin-ini.ts:147

---

general

general: SkinIniGeneral

Defined in: src/skin/skin-ini.ts:145

---

issues

issues: SkinIniParseIssue[]

Defined in: src/skin/skin-ini.ts:150

---

mania

mania: SkinIniMania

Defined in: src/skin/skin-ini.ts:149

---

newline

newline: "\n" | "\r\n" | "\r"

Defined in: src/skin/skin-ini.ts:142

---

nodes

nodes: SkinIniNode[]

Defined in: src/skin/skin-ini.ts:143

---

raw

raw: Record<string, Record<string, string>>

Defined in: src/skin/skin-ini.ts:144

---

source

source: string

Defined in: src/skin/skin-ini.ts:141

Methods

delete()

delete(section, key): boolean

Defined in: src/skin/skin-ini.ts:153

Parameters

Parameter	Type
section	string
key	string

Returns

boolean

This example requires Node.js.

import { SkinIniDocument } from 'osu-files'

return undefined

---

get()

get(section, key): string | undefined

Defined in: src/skin/skin-ini.ts:151

Parameters

Parameter	Type
section	string
key	string

Returns

string | undefined

This example requires Node.js.

import { SkinIniDocument } from 'osu-files'

return undefined

---

has()

has(section, key): boolean

Defined in: src/skin/skin-ini.ts:154

Parameters

Parameter	Type
section	string
key	string

Returns

boolean

This example requires Node.js.

import { SkinIniDocument } from 'osu-files'

return undefined

---

set()

set(section, key, value): void

Defined in: src/skin/skin-ini.ts:152

Parameters

Parameter	Type
section	string
key	string
value	SkinIniValue

Returns

void

This example requires Node.js.

import { SkinIniDocument } from 'osu-files'

return undefined