Class UrlResolver

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

Hierarchy

  • UrlResolver

Implements

Constructors

constructor

Properties

_contents _path

Accessors

path

Methods

getDownloadUrl isLocal isMalformed resolvePath resolveUrl

Constructors

constructor

Properties

Private _contents

_contents: any

Private _path

_path: any

Accessors

path

  • get path(): string

  • The path of the object, from which local urls can be derived.

    Returns string

  • set path(value): void

  • Parameters

    • value: string

    Returns void

Methods

getDownloadUrl

  • 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>

isLocal

  • 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 it also checks whether the path points to any of the IDrives that may be registered with the contents manager.

    Returns boolean

isMalformed

  • Whether the URL can be decoded using decodeURI.

    Parameters

    • url: string

    Returns boolean

resolvePath

  • 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>

resolveUrl

  • Resolve a relative url to an absolute url path.

    Parameters

    • url: string

    Returns Promise<string>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc