Class UrlResolver

A default resolver that uses a given reference path and a contents manager.

Implements

IUrlResolver

Index

Constructors

Accessors

Methods

getDownloadUrl isLocal isMalformed resolvePath resolveUrl

Constructors

constructor

new UrlResolver(options: IUrlResolverOptions): UrlResolver
Create a new url resolver.
Parameters
- options: IUrlResolverOptions
Returns UrlResolver
- Defined in packages/rendermime/src/registry.ts:339

Accessors

path

get path(): string
The path of the object, from which local urls can be derived.

Returns string
Implementation of IUrlResolver.path
- Defined in packages/rendermime/src/registry.ts:347
set path(value: string): void
The path of the object, from which local urls can be derived.
Parameters
- value: string
Returns void
Implementation of IUrlResolver.path
- Defined in packages/rendermime/src/registry.ts:350

Methods

getDownloadUrl

getDownloadUrl(urlPath: string): Promise<string>
Get the download url of a given absolute url path.

Notes
The returned URL may include a query parameter.
Parameters
- urlPath: string
Returns Promise<string>
Implementation of IUrlResolver.getDownloadUrl
- Defined in packages/rendermime/src/registry.ts:371

isLocal

isLocal(url: string, allowRoot?: boolean): boolean
Whether the URL should be handled by the resolver or not.
Parameters
- url: string
- allowRoot: boolean = false
  Whether the paths starting at Unix-style filesystem root (/) are permitted.
  
  Notes
  This is similar to the isLocal check in URLExt, but it also checks whether the path points to any of the IDrives that may be registered with the contents manager.
Returns boolean
Implementation of IUrlResolver.isLocal
- Defined in packages/rendermime/src/registry.ts:391

isMalformed

isMalformed(url: string): boolean
Whether the URL can be decoded using decodeURI.
Parameters
- url: string
Returns boolean
- Defined in packages/rendermime/src/registry.ts:451

resolvePath

resolvePath(path: string): Promise<null | IRenderMime.IResolvedLocation>
Resolve a path from Jupyter kernel to a path:
- relative to root_dir (preferably) this is in jupyter-server scope,
- path understood and known by kernel (if such a path exists). Returns null if there is no file matching provided path in neither kernel nor jupyter-server contents manager.
Parameters
- path: string
Returns Promise<null | IRenderMime.IResolvedLocation>
Implementation of IUrlResolver.resolvePath
- Defined in packages/rendermime/src/registry.ts:408

resolveUrl

resolveUrl(url: string): Promise<string>
Resolve a relative url to an absolute url path.
Parameters
- url: string
Returns Promise<string>
Implementation of IUrlResolver.resolveUrl
- Defined in packages/rendermime/src/registry.ts:357