Skip to content

Opensearch dashboards.basepath

Home > opensearch-dashboards > BasePath

BasePath class

Access or manipulate the OpenSearch Dashboards base path

Signature:

export declare class BasePath

Remarks

The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the BasePath class.

Properties

Property Modifiers Type Description
get (request: OpenSearchDashboardsRequest | LegacyRequest) => string returns basePath value, specific for an incoming request.
prepend (path: string) => string Prepends path with the basePath.
remove (path: string) => string Removes the prepended basePath from the path.
serverBasePath string returns the server's basePathSee BasePath.get for getting the basePath value for a specific request
set (request: OpenSearchDashboardsRequest | LegacyRequest, requestSpecificBasePath: string) => void sets basePath value, specific for an incoming request.