abstractFetchResource

A base class for Resources that require fetching data from a remote URL.

Hierarchy

• Resource
  • FetchResource
    • CorePluginResource
    • CoreThemeResource
    • UrlResource

Index

Constructors

• constructor

Properties

• progress

Accessors

• isAsync
• name

Methods

• resolve
• setPlayground
• create

Constructors

constructor

• new FetchResource(progress?: ProgressTracker): FetchResource

• Overrides Resource.constructor

  Creates a new instance of FetchResource.

  ---

  Parameters

  • optionalprogress: ProgressTracker

    The progress tracker.

  Returns FetchResource

Properties

publicoptionalprogress

progress?: ProgressTracker

Inherited from Resource.progress

The progress tracker.

Accessors

isAsync

• get isAsync(): boolean

• Overrides Resource.isAsync

  Whether this Resource is loaded asynchronously

  ---

  Returns boolean

name

• get name(): string

• Overrides Resource.name

  The name of the referenced file

  ---

  Returns string

Methods

resolve

• resolve(): Promise<File>

• Overrides Resource.resolve

  Resolves the file contents

  ---

  Returns Promise<File>

  The resolved file.

setPlayground

• setPlayground(playground: UniversalPHP): void

• Inherited from Resource.setPlayground

  Parameters

  • playground: UniversalPHP

  Returns void

staticcreate

• create(ref: FileReference, options: ResourceOptions): Resource

• Inherited from Resource.create

  Creates a new Resource based on the given file reference

  ---

  Parameters

  • ref: FileReference

    The file reference to create the Resource for

  • options: ResourceOptions

    Additional options for the Resource

  Returns Resource

  A new Resource instance