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

🎈 小何同学的JavaScript工具箱

import { NullableString } from "../types.js";
/**
 * 分割字符串-配置项
 *
 * @since 0.0.1
 */
interface ISplitOptions {
    /**
     * 是否移除开头的分隔符
     */
    readonly removeLeadingSeparator?: boolean;
    /**
     * 是否移除结尾的分隔符
     */
    readonly removeTrailingSeparator?: boolean;
}
/**
 * 分割字符串-默认配置项
 *
 * @since 0.0.1
 */
declare const DefaultSplitOptions: ISplitOptions;
/**
 * 分割字符串
 *
 * @since 0.0.1
 * @param [str]                                     字符串
 * @param [separator=","]                           分隔符
 * @param [options]                                 配置项
 * @param [options.removeLeadingSeparator=true]     是否移除开头的分隔符
 * @param [options.removeTrailingSeparator=true]    是否移除结尾的分隔符
 * @returns {string[]}                              字符串分割结果数组
 */
declare function split(str: NullableString, separator?: string, options?: ISplitOptions): string[];
export { ISplitOptions, DefaultSplitOptions, split };