superstatic/lib/utils/pathutils.d.ts

A static file server for fancy apps

/**
 * Copyright (c) 2022 Google LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
/**
 * @param pathname path to check.
 * @return the path with "/index.html" appended, if required.
 */
export declare function asDirectoryIndex(pathname: string): string;
/**
 * @param pathname path to check.
 * @return true if pathname ends with "/index.html".
 */
export declare function isDirectoryIndex(pathname: string): boolean;
/**
 * @param pathname path to check.
 * @return true if it ends with a slash.
 */
export declare function hasTrailingSlash(pathname: string): boolean;
/**
 * @param pathname path to check.
 * @return pathname with a trailing slash.
 */
export declare function addTrailingSlash(pathname: string): string;
/**
 * @param pathname path to check.
 * @return pathname without a trailing slash.
 */
export declare function removeTrailingSlash(pathname: string): string;
/**
 * @param pathname path to check.
 * @return pathname with any "//" replaced with "/".
 */
export declare function normalizeMultiSlashes(pathname: string): string;
/**
 * @param string string to check.
 * @param rm string to search for.
 * @return string with rm removed if it's the end of string. Else, string.
 */
export declare function removeTrailingString(string: string, rm: string): string;