UrlResource

A Resource that represents a file available from a URL.

Hierarchy

• FetchResource
  • UrlResource

Index

Constructors

• constructor

Properties

• progress

Accessors

• isAsync
• name

Methods

• getURL
• resolve
• setPlayground
• create

Constructors

constructor

• new UrlResource(resource: UrlReference, progress?: ProgressTracker): UrlResource

• Overrides FetchResource.constructor

  Creates a new instance of UrlResource.

  ---

  Parameters

  • resource: UrlReference

    The URL reference.

  • optionalprogress: ProgressTracker

    The progress tracker.

  Returns UrlResource

Properties

publicoptionalprogress

progress?: ProgressTracker

Inherited from FetchResource.progress

The progress tracker.

Accessors

isAsync

• get isAsync(): boolean

• Inherited from FetchResource.isAsync

  Whether this Resource is loaded asynchronously

  ---

  Returns boolean

name

• get name(): string

• Inherited from FetchResource.name

  The name of the referenced file

  ---

  Returns string

Methods

getURL

• getURL(): string

• Overrides FetchResource.getURL

  @inheritDoc

  ---

  Returns string

resolve

• resolve(): Promise<File>

• Inherited from FetchResource.resolve

  Resolves the file contents

  ---

  Returns Promise<File>

  The resolved file.

setPlayground

• setPlayground(playground: UniversalPHP): void

• Inherited from FetchResource.setPlayground

  Parameters

  • playground: UniversalPHP

  Returns void

staticcreate

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

• Inherited from FetchResource.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