VFSResource

A Resource that represents a file in the VFS (virtual file system) of the playground.

Hierarchy

• Resource<File>
  • VFSResource

Index

Constructors

• constructor

Properties

• _progress

Accessors

• isAsync
• name
• progress

Methods

• resolve
• setPlayground
• create

Constructors

constructor

• new VFSResource(resource: VFSReference, _progress?: ProgressTracker): VFSResource

• Overrides Resource.constructor

  Creates a new instance of VFSResource.

  ---

  Parameters

  • resource: VFSReference

    The VFS reference.

  • optional_progress: ProgressTracker

  Returns VFSResource

Properties

publicoptional_progress

_progress?: ProgressTracker

Inherited from Resource._progress

Accessors

isAsync

• get isAsync(): boolean

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

progress

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

• Inherited from Resource.progress

  Returns undefined | ProgressTracker

• Inherited from Resource.progress

  Parameters

  • value: undefined | ProgressTracker

  Returns void

Methods

resolve

• resolve(): Promise<File>

• Overrides Resource.resolve

  @inheritDoc

  ---

  Returns Promise<File>

setPlayground

• setPlayground(playground: UniversalPHP): void

• Inherited from Resource.setPlayground

  Parameters

  • playground: UniversalPHP

  Returns void

staticcreate

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

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

    Additional options for the Resource

  Returns Resource<Directory | File>

  A new Resource instance