Class AssetImporter

constructor

• new AssetImporter(logging?: boolean): AssetImporter

• Parameters

  • logging: boolean = false

  Returns AssetImporter

Readonlyimporters

cachedAssets

• get cachedAssets(): IAsset[]

• Returns IAsset[]

loadingManager

• get loadingManager(): LoadingManager

• Returns LoadingManager

addEventListener

• addEventListener<
      T extends
          | "processRaw"
          | "onLoad"
          | "onProgress"
          | "onStop"
          | "onError"
          | "onStart"
          | "loaderCreate"
          | "importFile"
          | "importFiles"
          | "processRawStart",
  >(
      type: T,
      listener: EventListener<IAssetImporterEvent, T, AssetImporter>,
  ): void

• Adds a listener to an event type.

  Type Parameters

  • T extends
        | "processRaw"
        | "onLoad"
        | "onProgress"
        | "onStop"
        | "onError"
        | "onStart"
        | "loaderCreate"
        | "importFile"
        | "importFiles"
        | "processRawStart"

  Parameters

  • type: T

    The type of event to listen to.
  • listener: EventListener<IAssetImporterEvent, T, AssetImporter>

    The function that gets called when the event is fired.

  Returns void

addImporter

• addImporter(...importers: IImporter[]): void

• Parameters

  • ...importers: IImporter[]

  Returns void

clearCache

• clearCache(): void

• Clear memory asset and loader cache. Browser cache and custom cache storage is not cleared with this.

  Returns void

clearLoaderCache

• clearLoaderCache(): void

• Returns void

dispose

• dispose(): void

• Returns void

import

• import<T extends undefined | ImportResult = ImportResult>(
      assetOrPath?: string | File | File[] | IAsset | IAsset[],
      options?: ImportAssetOptions,
  ): Promise<(undefined | T)[]>

• Import single or multiple assets(like in case of zip files) from a path(url) or an IAsset.

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • OptionalassetOrPath: string | File | File[] | IAsset | IAsset[]

    The path or asset to import
  • Optionaloptions: ImportAssetOptions

    Options for the import

  Returns Promise<(undefined | T)[]>

importAsset

• importAsset<T extends undefined | ImportResult = undefined | ImportResult>(
      asset?: IAsset,
      options?: ImportAssetOptions,
      onDownloadProgress?: (e: ProgressEvent) => void,
  ): Promise<T[]>

• Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • Optionalasset: IAsset
  • options: ImportAssetOptions = {}
  • OptionalonDownloadProgress: (e: ProgressEvent) => void

  Returns Promise<T[]>

importFile

• importFile<T extends undefined | ImportResult = undefined | ImportResult>(
      file?: File,
      options?: ImportAssetOptions,
      onDownloadProgress?: (e: ProgressEvent) => void,
  ): Promise<T[]>

• Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • Optionalfile: File
  • options: ImportAssetOptions = {}
  • OptionalonDownloadProgress: (e: ProgressEvent) => void

  Returns Promise<T[]>

importFiles

• importFiles<T extends undefined | ImportResult = undefined | ImportResult>(
      files: Map<string, IFile>,
      options?: ImportFilesOptions,
  ): Promise<Map<string, T[]>>

• Import multiple local files/blobs from a map of files, like when a local folder is loaded, or when multiple files are dropped.

  Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • files: Map<string, IFile>
  • options: ImportFilesOptions = {}

  Returns Promise<Map<string, T[]>>

importPath

• importPath<T extends undefined | ImportResult = undefined | ImportResult>(
      path: string,
      options?: ImportAssetOptions,
  ): Promise<T[]>

• Type Parameters

  • T extends undefined | ImportResult = undefined | ImportResult

  Parameters

  • path: string
  • options: ImportAssetOptions = {}

  Returns Promise<T[]>

importSingle

• importSingle<T extends undefined | ImportResult = ImportResult>(
      asset?: string | IAsset,
      options?: ImportAssetOptions,
  ): Promise<undefined | T>

• Import a single asset from a path(url) or an IAsset.

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • Optionalasset: string | IAsset
  • Optionaloptions: ImportAssetOptions

  Returns Promise<undefined | T>

processImported

• processImported(
      res: any,
      options: ProcessRawOptions,
      path?: string,
  ): Promise<any[]>

• Parameters

  • res: any
  • options: ProcessRawOptions
  • Optionalpath: string

  Returns Promise<any[]>

  Deprecated

  use processRaw instead

processRaw

• processRaw<T extends undefined | ImportResult = ImportResult>(
      res: T | T[],
      options: ProcessRawOptions,
      path?: string,
  ): Promise<T[]>

• Process the raw output from the loaders and return the updated/patched-objects.

  Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • res: T | T[]
  • options: ProcessRawOptions
  • Optionalpath: string

  Returns Promise<T[]>

processRawSingle

• processRawSingle<T extends undefined | ImportResult = ImportResult>(
      res: T,
      options: ProcessRawOptions,
      path?: string,
  ): Promise<T>

• Type Parameters

  • T extends undefined | ImportResult = ImportResult

  Parameters

  • res: T
  • options: ProcessRawOptions
  • Optionalpath: string

  Returns Promise<T>

registerFile

• registerFile(path: string, file?: IFile): undefined | ILoader

• Register a file in the database and return a loader for it. If the loader does not exist, it will be created.

  Parameters

  • path: string
  • Optionalfile: IFile

  Returns undefined | ILoader

removeImporter

• removeImporter(...importers: IImporter[]): void

• Parameters

  • ...importers: IImporter[]

  Returns void

resolveURL

• resolveURL(url: string): string

• Parameters

  • url: string

  Returns string

unregisterAllFiles

• unregisterAllFiles(): void

• Returns void

unregisterFile

• unregisterFile(path: string): void

• Remove a file from the database and revoke the object url if it exists.

  Parameters

  • path: string

  Returns void