Interface IResolver

An object that resolves relative URLs.

Hierarchy

IResolver

Index

Properties

isLocal? resolvePath?

Methods

getDownloadUrl resolveUrl

Properties

`Optional` isLocal

isLocal?: ((url, allowRoot?) => boolean)

Type declaration

- (url, allowRoot?): boolean
- Whether the URL should be handled by the resolver or not.
  Parameters
  - url: string
  - Optional allowRoot: boolean
    
    Whether the paths starting at Unix-style filesystem root (/) are permitted.
    
    Notes
    This is similar to the isLocal check in URLExt, but can also perform additional checks on whether the resolver should handle a given URL.
  Returns boolean

`Optional` resolvePath

resolvePath?: ((path) => Promise<IRenderMime.IResolvedLocation>)

Type declaration

- (path): Promise<IRenderMime.IResolvedLocation>
- Resolve a path from Jupyter kernel to a path:
  - relative to root_dir (preferrably) 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<IRenderMime.IResolvedLocation>

Methods

getDownloadUrl

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

Notes
This URL may include a query parameter.
Parameters
- url: string
Returns Promise<string>
- Defined in packages/rendermime-interfaces/src/index.ts:485

resolveUrl

resolveUrl(url): Promise<string>
Resolve a relative url to an absolute url path.
Parameters
- url: string
Returns Promise<string>
- Defined in packages/rendermime-interfaces/src/index.ts:477

Generated using TypeDoc