UrlResource

A Resource that represents a file available from a URL.

Hierarchy

• FetchResource
  • UrlResource

Index

Constructors

• constructor

Accessors

• isAsync
• name
• progress

Methods

• getURL
• resolve
• setPlayground
• create

Constructors

constructor

• new UrlResource(resource: UrlReference, progress?: ProgressTracker, options?: { corsProxy?: string }): UrlResource

• Overrides FetchResource.constructor

  Creates a new instance of UrlResource.

  ---

  Parameters

  • resource: UrlReference

    The URL reference.

  • optionalprogress: ProgressTracker

    The progress tracker.

  • optionaloptions: { corsProxy?: string }

  • optionalcorsProxy: string

  Returns UrlResource

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

progress

• get progress(): ProgressTracker
• set progress(value: ProgressTracker): void

• Inherited from FetchResource.progress

  Returns ProgressTracker

• Inherited from FetchResource.progress

  Parameters

  • value: ProgressTracker

  Returns void

Methods

getURL

• getURL(): string

• Overrides FetchResource.getURL

  @inheritDoc

  ---

  Returns string

resolve

• resolve(): Promise<File>

• Inherited from FetchResource.resolve

  @inheritDoc

  ---

  Returns Promise<File>

setPlayground

• setPlayground(playground: UniversalPHP): void

• Inherited from FetchResource.setPlayground

  Parameters

  • playground: UniversalPHP

  Returns void

staticcreate

• create(ref: FileReference | DirectoryReference, options: { corsProxy?: string; progress?: ProgressTracker; semaphore?: default; streamBundledFile?: StreamBundledFile }): Resource<File | Directory>

• Inherited from FetchResource.create

  Creates a new Resource based on the given file reference

  ---

  Parameters

  • ref: FileReference | DirectoryReference

    The file reference to create the Resource for

  • options: { corsProxy?: string; progress?: ProgressTracker; semaphore?: default; streamBundledFile?: StreamBundledFile }

    Additional options for the Resource

  • optionalcorsProxy: string

  • optionalprogress: ProgressTracker

  • optionalsemaphore: default

    Optional semaphore to limit concurrent downloads

  • optionalstreamBundledFile: StreamBundledFile

  Returns Resource<File | Directory>

  A new Resource instance