SemaphoreResource <T>

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

Hierarchy

• DecoratedResource<T>
  • SemaphoreResource

Index

Constructors

• constructor

Accessors

• isAsync
• name
• progress

Methods

• resolve
• setPlayground
• create

Constructors

constructor

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

• Overrides DecoratedResource.constructor

  Type parameters

  • T: Resource

  Parameters

  • resource: T

  • semaphore: default

  Returns SemaphoreResource<T>

Accessors

isAsync

• get isAsync(): boolean

• Inherited from DecoratedResource.isAsync

  Whether this Resource is loaded asynchronously

  ---

  Returns boolean

name

• get name(): string

• Inherited from DecoratedResource.name

  The name of the referenced file

  ---

  Returns string

progress

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

• Inherited from DecoratedResource.progress

  Optional progress tracker to monitor progress

  ---

  Returns undefined | ProgressTracker

• Inherited from DecoratedResource.progress

  Optional progress tracker to monitor progress

  ---

  Parameters

  • value: undefined | ProgressTracker

  Returns void

Methods

resolve

• resolve(): Promise<File>

• Overrides DecoratedResource.resolve

  Resolves the file contents

  ---

  Returns Promise<File>

  The resolved file.

setPlayground

• setPlayground(playground: UniversalPHP): Promise<void>

• Inherited from DecoratedResource.setPlayground

  @inheritDoc

  ---

  Parameters

  • playground: UniversalPHP

  Returns Promise<void>

staticcreate

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

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