AssetUtil

Abstract base class for defining asset-type-specific behavior.

Each asset type (image, video, bookmark, etc.) has a corresponding AssetUtil that handles type-specific operations like determining supported MIME types and creating assets from files.

abstract class AssetUtil<Asset extends TLAsset = TLAsset> {}

Constructs a new instance of the AssetUtil class

Parameters

Editor;

Properties

static migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;

static props?: RecordProps<TLUnknownAsset>;

The type of the asset util, which should match the asset's type.

static type: string;

editor: Editor;

Options for this asset util. Override this to provide customization options for your asset. Use AssetUtil.configure to customize existing asset utils.

options: {};

Methods

Configure this asset util's options.

static configure<T extends TLAssetUtilConstructor<any, any>>(
  this: T,
  options: T extends new (...args: any[]) => {
    options: infer Options;
  }
    ? Partial<Options>
    : never,
): T;

Parameters

T;

T extends new (...args: any[]) => {
  options: infer Options;
}
  ? Partial<Options>
  : never;

Returns

T;

Check whether this asset type accepts a given MIME type.

acceptsMimeType(mimeType: string): boolean;

Parameters

string;

Returns

boolean;

Create an asset from a file. Return null if this asset type can't handle the file.

getAssetFromFile(_file: File, _assetId: TLAssetId): Promise<Asset | null>;

Parameters

File;

TLAssetId;

Returns

Promise<Asset | null>;

Get the default props for an asset of this type.

abstract getDefaultProps(): Asset["props"];

Get the MIME types that this asset type supports. Return an empty array if this asset type doesn't support files (e.g. bookmarks).

getSupportedMimeTypes(): readonly string[];