Class ScratchStorage

constructor

• new ScratchStorage(): ScratchStorage

  Returns ScratchStorage

_helpers

Asset

• get Asset(): typeof Asset

  Returns typeof Asset

AssetType

• get AssetType(): typeof ScratchStorage.AssetType

  Returns typeof ScratchStorage.AssetType

DataFormat

• get DataFormat(): typeof DataFormat

  Returns typeof DataFormat

addHelper

• addHelper(helper: Helper, priority?: number): void

  Parameters

  • helper: Helper
  • Optionalpriority: number

  Returns void

addWebSource

• addWebSource(types: ScratchStorage.AssetType[], getFunction: UrlFunction): void

  Parameters

  • types: ScratchStorage.AssetType[]
  • getFunction: UrlFunction

  Returns void

  Deprecated

  Use addWebStore instead.

addWebStore

• addWebStore(
      types: ScratchStorage.AssetType[],
      getFunction: UrlFunction,
      createFunction?: UrlFunction,
      updateFunction?: UrlFunction,
  ): void

  Parameters

  • types: ScratchStorage.AssetType[]
  • getFunction: UrlFunction
  • OptionalcreateFunction: UrlFunction
  • OptionalupdateFunction: UrlFunction

  Returns void

cache

• cache(
      assetType: ScratchStorage.AssetType,
      dataFormat: DataFormat,
      data: Uint8Array,
      assetId: string,
  ): string

  Parameters

  • assetType: ScratchStorage.AssetType
  • dataFormat: DataFormat
  • data: Uint8Array
  • assetId: string

  Returns string

createAsset

• createAsset(
      assetType: ScratchStorage.AssetType,
      dataFormat: DataFormat,
      data: Uint8Array,
      assetId: null,
      generateId: true,
  ): Asset

  Parameters

  • assetType: ScratchStorage.AssetType
  • dataFormat: DataFormat
  • data: Uint8Array
  • assetId: null
  • generateId: true

  Returns Asset

• createAsset(
      assetType: ScratchStorage.AssetType,
      dataFormat: DataFormat,
      data: Uint8Array,
      assetId: string,
      generateId?: boolean,
  ): Asset

  Parameters

  • assetType: ScratchStorage.AssetType
  • dataFormat: DataFormat
  • data: Uint8Array
  • assetId: string
  • OptionalgenerateId: boolean

  Returns Asset

get

• get(assetId: string): Asset | null

  Synchronously get a cached asset.

  Parameters

  • assetId: string

  Returns Asset | null

getDefaultAssetId

• getDefaultAssetId(type: ScratchStorage.AssetType): string | undefined

  Parameters

  • type: ScratchStorage.AssetType

  Returns string | undefined

load

• load(
      assetType: ScratchStorage.AssetType,
      assetId: string,
      dataFormat: DataFormat,
  ): Promise<Asset | null>

  Parameters

  • assetType: ScratchStorage.AssetType
  • assetId: string
  • dataFormat: DataFormat

  Returns Promise<Asset | null>

setDefaultAssetId

• setDefaultAssetId(type: ScratchStorage.AssetType, id: string): void

  Parameters

  • type: ScratchStorage.AssetType
  • id: string

  Returns void

store

• store(
      assetType: ScratchStorage.AssetType,
      dataFormat: DataFormat,
      data: Uint8Array,
      assetId: string,
  ): Promise<unknown>

  Parameters

  • assetType: ScratchStorage.AssetType
  • dataFormat: DataFormat
  • data: Uint8Array
  • assetId: string

  Returns Promise<unknown>