Class ServeResourceHandler

Serves resources stored in the bundle. Some resources are removed from the bundle and stored separately to shrink what needs to be kept in memory.

Hierarchy

ServeResourceHandler

Implements

OfflineHandler

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ServeResourceHandler(app: ViewerApplication, resourceGetter: function, resourceSetter: function, resourceRemover: function): ServeResourceHandler

- Defined in Mapping.Infrastructure.ts:28680
Parameters
- app: ViewerApplication
- resourceGetter: function
  - - (key: string): Promise<string>
    - Parameters
      - key: string
      Returns Promise<string>
- resourceSetter: function
  - - (key: string, value: string): Promise<void>
    - Parameters
      - key: string
      - value: string
      Returns Promise<void>
- resourceRemover: function
  - - (key: string): Promise<void>
    - Parameters
      - key: string
      Returns Promise<void>
Returns ServeResourceHandler

Properties

app

app: ViewerApplication

isReady

isReady: Observable<boolean>

name

name: string

resourceGetter

resourceGetter: function

Type declaration

- (key: string): Promise<string>
- Parameters
  - key: string
  Returns Promise<string>

resourceRemover

resourceRemover: function

Type declaration

- (key: string): Promise<void>
- Parameters
  - key: string
  Returns Promise<void>

resourceSetter

resourceSetter: function

Type declaration

- (key: string, value: string): Promise<void>
- Parameters
  - key: string
  - value: string
  Returns Promise<void>

Methods

clear

clear(): void

- Defined in Mapping.Infrastructure.ts:28698
Clear all known resources.

Returns void

getResourceValue

getResourceValue(key: string): Promise<any>

- Defined in Mapping.Infrastructure.ts:28721
Get the resouce for the given key.

Parameters
- key: string
Returns Promise<any>

handle

handle(request: RequestContext, rule: RoutingRule, matches: RegExpExecArray, cancellationToken: CancellationToken): boolean

Implementation of OfflineHandler.handle
- Defined in Mapping.Infrastructure.ts:28689
Serve the request using the given rule from the bundle.

Parameters
- request: RequestContext
  
  The request to serve.
- rule: RoutingRule
  
  The rule from the bundle that matches the request.
- matches: RegExpExecArray
  
  Regex capturing groups.
- cancellationToken: CancellationToken
Returns boolean

Whether the request was successfully handled.

loadBundle

loadBundle(bundle: Bundle): void

- Defined in Mapping.Infrastructure.ts:28694
Serve all future requests with resources from the given bundle.

Parameters
- bundle: Bundle
  
  The bundle to serve from.
Returns void

stripAndStoreBundle

stripAndStoreBundle(bundle: Bundle): Promise<Bundle>

- Defined in Mapping.Infrastructure.ts:28705
Strip large values out of the bundle and store them separately. This does not make the bundle active. That is done with loadBundle.

Parameters
- bundle: Bundle
  
  The bundle to process.
Returns Promise<Bundle>

a promise of the bundle that was passed in, after it is processed.

unstoreBundle

unstoreBundle(bundle: Bundle): Promise<Bundle>

- Defined in Mapping.Infrastructure.ts:28712
Unstore all entries stored by stripAndStoreBundle. The values are not returned to the bundle. It's assumed we're just going to throw it away.

Parameters
- bundle: Bundle
  
  The bundle to process.
Returns Promise<Bundle>

a promise of the bundle that was passed in, after it is processed.

updateEntry

updateEntry(bundleId: string, entry: BundleResourceEntry): Promise<void>

- Defined in Mapping.Infrastructure.ts:28716
Updates an entry in the bundle.

Parameters
- bundleId: string
- entry: BundleResourceEntry
Returns Promise<void>

Static getResourceStorageKey

getResourceStorageKey(bundleId: string, entryKey: string): string

- Defined in Mapping.Infrastructure.ts:28727
Parameters
- bundleId: string
- entryKey: string
Returns string