Interface: FileModule

Defined in: src/files.ts:180

import type { FileModule } from 'osu-files'

return db.files.get.first()?.Hash

Properties

get

readonly get: Files

Defined in: src/files.ts:182

Returns read-only file snapshots through get.

---

store?

readonly optional store?: FileStore

Defined in: src/files.ts:184

Stores files in the content-addressed store.

---

write

readonly write: Crud<File>

Defined in: src/files.ts:192

File records cannot be updated.

Methods

cleanupOrphanedFiles()

cleanupOrphanedFiles(): FileCleanupReport

Defined in: src/files.ts:194

Deletes unreferenced files.

Returns

FileCleanupReport

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined

---

fileRef()

fileRef(hash, filename): FileRef

Defined in: src/files.ts:196

Creates a file reference.

Parameters

Parameter	Type
hash	string
filename	string

Returns

FileRef

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined

---

fileRefWithContent()

fileRefWithContent(hash, filename): FileRef

Defined in: src/files.ts:198

Creates a file reference with local content when available.

Parameters

Parameter	Type
hash	string
filename	string

Returns

FileRef

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined

---

put()

put(content, expectedHash?): object

Defined in: src/files.ts:186

Stores a file and returns its hash.

Parameters

Parameter	Type
content	Buffer
expectedHash?	string

Returns

object

created

created: boolean

hash

hash: string

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined

---

read()

read(hash, verify?): Buffer

Defined in: src/files.ts:188

Reads a stored file.

Parameters

Parameter	Type
hash	string
verify?	boolean

Returns

Buffer

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined

---

verify()

verify(hash): boolean

Defined in: src/files.ts:190

Checks a stored file.

Parameters

Parameter	Type
hash	string

Returns

boolean

This example requires Node.js.

import { FileModule } from 'osu-files'

return undefined