Type Alias: OwnedFileEditor

OwnedFileEditor = object

Defined in: src/skins.ts:19

This example requires Node.js.

import type { OwnedFileEditor } from 'osu-files'

const value = {} as OwnedFileEditor
return value

Properties

filename

readonly filename: string

Defined in: src/skins.ts:21

Normalized owner-local filename.

---

hash

readonly hash: string

Defined in: src/skins.ts:23

Hash of the blob selected when this editor was opened.

Methods

edit()

edit(transform): Promise<boolean>

Defined in: src/skins.ts:29

Transforms and replaces the selected blob atomically.

Parameters

Parameter	Type
transform	(content) => Buffer<ArrayBufferLike> | Promise<Buffer<ArrayBufferLike>>

Returns

Promise<boolean>

This example requires Node.js.

import { OwnedFileEditor } from 'osu-files'

return undefined

---

read()

read(): Buffer

Defined in: src/skins.ts:25

Reads and verifies the selected blob.

Returns

Buffer

This example requires Node.js.

import { OwnedFileEditor } from 'osu-files'

return undefined

---

replace()

replace(content): Promise<boolean>

Defined in: src/skins.ts:27

Replaces the selected blob for this owner using copy-on-write.

Parameters

Parameter	Type
content	Buffer

Returns

Promise<boolean>

This example requires Node.js.

import { OwnedFileEditor } from 'osu-files'

return undefined