Interface UseAssetReturn

UseAssetReturn Represents the return type of the useAsset hook.

Hierarchy

  • Partial<AssetType>
    • UseAssetReturn

Properties

asset createdAt? data? delete description? fetched id? name? projectId? push pushFile refresh schemaId? setAsset setFile tags? type? url?

Properties

asset

asset: null | AssetType

The current asset, or null if no asset is selected.

Optional createdAt

createdAt?: string

Optional data

data?: string

delete

delete: AssetDeleteMethod

Function to delete the asset.

Optional description

description?: string

fetched

fetched: boolean

Boolean indicating whether the asset has been successfully fetched.

Optional id

id?: string

Optional name

name?: string

Optional projectId

projectId?: string

push

push: AssetPushMethod

Function to push the asset.

pushFile

pushFile: AssetPushFileMethod

Function to push the associated file.

refresh

refresh: AssetFetchMethod

Function to refresh or fetch the asset again.

Optional schemaId

schemaId?: string

setAsset

setAsset: Dispatch<SetStateAction<null | AssetType>>

Function to update the asset state.

setFile

setFile: Dispatch<SetStateAction<null | File>>

Function to update the file state.

Optional tags

tags?: string[]

Optional type

type?: string

Optional url

url?: string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc