SemaphoreResource <T>

A decorator for a resource that adds concurrency control functionality through a semaphore.

Hierarchy

• ResourceDecorator<T>
  • SemaphoreResource

Index

Constructors

• constructor

Accessors

• isAsync
• name
• progress

Methods

• resolve
• setPlayground
• create

Constructors

constructor

• new SemaphoreResource<T>(resource: Resource<T>, semaphore: default): SemaphoreResource<T>

• Overrides ResourceDecorator.constructor

  Type parameters

  • T: File | Directory

  Parameters

  • resource: Resource<T>

  • semaphore: default

  Returns SemaphoreResource<T>

Accessors

isAsync

• get isAsync(): boolean

• Inherited from ResourceDecorator.isAsync

  Whether this Resource is loaded asynchronously

  ---

  Returns boolean

name

• get name(): string

• Inherited from ResourceDecorator.name

  The name of the referenced file

  ---

  Returns string

progress

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

• Inherited from ResourceDecorator.progress

  @inheritDoc

  ---

  Returns ProgressTracker

• Inherited from ResourceDecorator.progress

  @inheritDoc

  ---

  Parameters

  • value: ProgressTracker

  Returns void

Methods

resolve

• resolve(): Promise<T>

• Overrides ResourceDecorator.resolve

  @inheritDoc

  ---

  Returns Promise<T>

setPlayground

• setPlayground(playground: UniversalPHP): void

• Inherited from ResourceDecorator.setPlayground

  @inheritDoc

  ---

  Parameters

  • playground: UniversalPHP

  Returns void

staticcreate

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

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