Skip to main content

Class: default<T>

Defined in: src/lib/assets/index.ts:129

Reads and writes the collection files that users export and import assets of one kind in (e.g. brush presets), migrating files of older versions to the current one.

Example​

const presets = brushPresetFile.parse(await file.text()); // throws AssetFileError
const json = brushPresetFile.write(presets);

Type Parameters​

T​

T

Constructors​

Constructor​

new default<T>(config): AssetFile<T>

Defined in: src/lib/assets/index.ts:130

Parameters​

config​

AssetFileConfig<T>

Returns​

AssetFile<T>

Properties​

config​

readonly config: AssetFileConfig<T>

Defined in: src/lib/assets/index.ts:130

Accessors​

schemaUrl​

Get Signature​

get schemaUrl(): string

Defined in: src/lib/assets/index.ts:133

URL of the schema of the files this writes

Returns​

string

Methods​

fileName()​

fileName(date?, prefix?): string

Defined in: src/lib/assets/index.ts:227

The name of a file exported on a day, starting with a prefix (see PaintCanvasNames.filePrefix).

Parameters​

date?​

Date = ...

prefix?​

string = "paintcanvas"

Returns​

string

Example​

brushPresetFile.fileName(new Date(2026, 10, 11)); // "paintcanvas-brush-presets-2026-11-11.json"

parse()​

parse(text, context?): T[]

Defined in: src/lib/assets/index.ts:193

The assets in a file's text. Throws an AssetFileError if it isn't JSON, or (see read) can't be read.

Parameters​

text​

string

context?​

AssetFileContext = {}

what migrations fill in (see read)

Returns​

T[]

Example​

brushPresetFile.parse('{ "$schema": "...", "@type": "PaintCanvas/BrushConfigCollection", "items": [] }'); // []

read()​

read(data, context?): T[]

Defined in: src/lib/assets/index.ts:156

The assets in a file's data, migrated from an older version if needed. Throws an AssetFileError if it isn't this kind of file, isn't valid, or is a version that can't be read.

Parameters​

data​

unknown

context?​

AssetFileContext = {}

what migrations fill in, e.g. the author of assets that have none

Returns​

T[]


versionOf()​

versionOf(data): string | undefined

Defined in: src/lib/assets/index.ts:143

The version of a file of this kind, or undefined if it isn't one.

Parameters​

data​

Record<string, unknown>

Returns​

string | undefined

Example​

brushPresetFile.versionOf({ $schema: ".../brush-preset-collection-1.0.0.json" }); // "1.0.0"

write()​

write(items): string

Defined in: src/lib/assets/index.ts:210

Write assets to a file (JSON) of the current version. Throws an AssetFileError if there are none, or they don't match the schema.

Parameters​

items​

readonly T[]

Returns​

string

Example​

brushPresetFile.write([myPreset]); // '{ "$schema": "...", "@type": "PaintCanvas/BrushConfigCollection", "items": [...] }'