xiaohejs/lib/esm/string/convertUrl.d.ts

🎈 小何同学的JavaScript工具箱

import { NullableString } from "../types.js";
/**
 * 转换Url相对路径-缺省值
 *
 * @since 0.1.0
 */
interface IConvertUrlConfig {
    /**
     * Url基地址
     */
    base: NullableString;
    /**
     * 例外的Url前缀
     */
    excludes: string[];
}
/**
 * 转换Url相对路径-配置项
 *
 * @since 0.0.6
 */
interface IConvertUrlOptions {
    /**
     * Url基地址
     */
    readonly base?: NullableString;
    /**
     * Url额外前缀
     */
    readonly prefix?: NullableString;
}
/**
 * 转换Url相对路径-默认缺省值
 *
 * @since 0.1.0
 */
declare const ConvertUrlConfig: IConvertUrlConfig;
/**
 * 转换Url相对路径-默认配置项
 *
 * @since 0.0.6
 */
declare const DefaultConvertUrlOptions: IConvertUrlOptions;
/**
 * 转换Url相对路径
 *
 * @since 0.0.6
 * @param [value]                                 Url地址
 * @param [options]                               配置项
 * @param [options.base=ConvertUrlConfig.base]    Url基地址
 * @param [options.prefix]                        Url额外前缀
 * @returns {NullableString}                      转换后的Url地址
 */
declare function convertUrl(value: NullableString, options?: IConvertUrlOptions): NullableString;
export { IConvertUrlConfig, IConvertUrlOptions, ConvertUrlConfig, DefaultConvertUrlOptions, convertUrl };