@opensumi/ide-utils 2.16.6

package/lib/strings.d.ts

@@ -0,0 +1,181 @@
+/**
+ * The empty string.
+ */
+export declare const empty = "";
+/**
+ * 浏览器全局可以直接使用 TextEncoder/TextDecoder
+ * Node.js 11+ 才可以全局使用，以下需要 require('util')
+ */
+export declare namespace stringUtils {
+    const StringTextEncoder: any;
+    const StringTextDecoder: any;
+}
+export declare function isFalsyOrWhitespace(str: string | undefined): boolean;
+/**
+ * @returns the provided number with the given number of preceding zeros.
+ */
+export declare function pad(n: number, l: number, char?: string): string;
+/**
+ * Helper to produce a string with a variable number of arguments. Insert variable segments
+ * into the string using the {n} notation where N is the index of the argument following the string.
+ * @param value string to which formatting is applied
+ * @param args replacements for {n}-entries
+ */
+export declare function format(value: string, ...args: any[]): string;
+/**
+ * Handles mnemonics for buttons. Depending on OS:
+ * - Windows: Supported via & character (replace && with & and & with && for escaping)
+ * -   Linux: Supported via _ character (replace && with _)
+ * -   macOS: Unsupported (replace && with empty string)
+ */
+export declare function mnemonicButtonLabel(label: string, forceDisableMnemonics?: boolean): string;
+/**
+ * Converts HTML characters inside the string to use entities instead. Makes the string safe from
+ * being used e.g. in HTMLElement.innerHTML.
+ */
+export declare function escape(html: string): string;
+/**
+ * Escapes regular expression characters in a given string
+ */
+export declare function escapeRegExpCharacters(value: string): string;
+/**
+ * Counts how often `character` occurs inside `value`.
+ */
+export declare function count(value: string, character: string): number;
+/**
+ * Removes all occurrences of needle from the beginning and end of haystack.
+ * @param haystack string to trim
+ * @param needle the thing to trim (default is a blank)
+ */
+export declare function trim(haystack: string, needle?: string): string;
+/**
+ * Removes all occurrences of needle from the beginning of haystack.
+ * @param haystack string to trim
+ * @param needle the thing to trim
+ */
+export declare function ltrim(haystack: string, needle: string): string;
+/**
+ * Removes all occurrences of needles from the end of haystack.
+ * @param source
+ * @param needles
+ * @example
+ * ```ts
+ * let source = '/path/to/file.ts,;';
+ * const res = multiRightTrim(source, [`,`, ';']);
+ * // res === '/path/to/file.ts';
+ *  ```
+ */
+export declare function multiRightTrim(source: string, needles: string[]): string;
+/**
+ * Removes all occurrences of needle from the end of haystack.
+ * @param haystack string to trim
+ * @param needle the thing to trim
+ */
+export declare function rtrim(haystack: string, needle: string): string;
+export declare function convertSimple2RegExpPattern(pattern: string): string;
+export declare function stripWildcards(pattern: string): string;
+/**
+ * Determines if haystack starts with needle.
+ */
+export declare function startsWith(haystack: string, needle: string): boolean;
+/**
+ * Determines if haystack ends with needle.
+ */
+export declare function endsWith(haystack: string, needle: string): boolean;
+export interface RegExpOptions {
+    matchCase?: boolean;
+    wholeWord?: boolean;
+    multiline?: boolean;
+    global?: boolean;
+    unicode?: boolean;
+}
+export declare function createRegExp(searchString: string, isRegex: boolean, options?: RegExpOptions): RegExp;
+export declare function regExpLeadsToEndlessLoop(regexp: RegExp): boolean;
+export declare function regExpContainsBackreference(regexpValue: string): boolean;
+export declare function regExpFlags(regexp: RegExp): string;
+/**
+ * Returns first index of the string that is not whitespace.
+ * If string is empty or contains only whitespaces, returns -1
+ */
+export declare function firstNonWhitespaceIndex(str: string): number;
+/**
+ * Returns the leading whitespace of the string.
+ * If the string contains only whitespaces, returns entire string
+ */
+export declare function getLeadingWhitespace(str: string, start?: number, end?: number): string;
+/**
+ * Returns last index of the string that is not whitespace.
+ * If string is empty or contains only whitespaces, returns -1
+ */
+export declare function lastNonWhitespaceIndex(str: string, startIndex?: number): number;
+export declare function compare(a: string, b: string): number;
+export declare function compareIgnoreCase(a: string, b: string): number;
+export declare function isLowerAsciiLetter(code: number): boolean;
+export declare function isUpperAsciiLetter(code: number): boolean;
+export declare function equalsIgnoreCase(a: string, b: string): boolean;
+export declare function startsWithIgnoreCase(str: string, candidate: string): boolean;
+/**
+ * @returns the length of the common prefix of the two strings.
+ */
+export declare function commonPrefixLength(a: string, b: string): number;
+/**
+ * @returns the length of the common suffix of the two strings.
+ */
+export declare function commonSuffixLength(a: string, b: string): number;
+/**
+ * Return the overlap between the suffix of `a` and the prefix of `b`.
+ * For instance `overlap("foobar", "arr, I'm a pirate") === 2`.
+ */
+export declare function overlap(a: string, b: string): number;
+export declare function isHighSurrogate(charCode: number): boolean;
+export declare function isLowSurrogate(charCode: number): boolean;
+/**
+ * Returns true if `str` contains any Unicode character that is classified as "R" or "AL".
+ */
+export declare function containsRTL(str: string): boolean;
+export declare function containsEmoji(str: string): boolean;
+/**
+ * Returns true if `str` contains only basic ASCII characters in the range 32 - 126 (including 32 and 126) or \n, \r, \t
+ */
+export declare function isBasicASCII(str: string): boolean;
+export declare function containsFullWidthCharacter(str: string): boolean;
+export declare function isFullWidthCharacter(charCode: number): boolean;
+/**
+ * Given a string and a max length returns a shorted version. Shorting
+ * happens at favorable positions - such as whitespace or punctuation characters.
+ */
+export declare function lcut(text: string, n: number): string;
+export declare function removeAnsiEscapeCodes(str: string): string;
+export declare const removeAccents: (str: string) => string;
+export declare const UTF8_BOM_CHARACTER: string;
+export declare function startsWithUTF8BOM(str: string): boolean;
+export declare function stripUTF8BOM(str: string): string;
+export declare function safeBtoa(str: string): string;
+export declare function repeat(s: string, count: number): string;
+/**
+ * Checks if the characters of the provided query string are included in the
+ * target string. The characters do not have to be contiguous within the string.
+ */
+export declare function fuzzyContains(target: string, query: string): boolean;
+export declare function containsUppercaseCharacter(target: string, ignoreEscapedChars?: boolean): boolean;
+export declare function uppercaseFirstLetter(str: string): string;
+export declare function getNLines(str: string, n?: number): string;
+/**
+ * See http://en.wikipedia.org/wiki/Surrogate_pair
+ */
+export declare function computeCodePoint(highSurrogate: number, lowSurrogate: number): number;
+/**
+ * get the code point that begins at offset `offset`
+ */
+export declare function getNextCodePoint(str: string, len: number, offset: number): number;
+/**
+ * A manual encoding of `str` to UTF8.
+ * Use only in environments which do not offer native conversion methods!
+ */
+export declare function encodeUTF8(str: string): Uint8Array;
+/**
+ * A manual decoding of a UTF8 string.
+ * Use only in environments which do not offer native conversion methods!
+ */
+export declare function decodeUTF8(buffer: Uint8Array): string;
+//# sourceMappingURL=strings.d.ts.map

package/lib/strings.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"strings.d.ts","sourceRoot":"","sources":["../src/strings.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,eAAO,MAAM,KAAK,KAAK,CAAC;AAKxB;;;GAGG;AACH,yBAAiB,WAAW,CAAC;IACpB,MAAM,iBAAiB,KAA6D,CAAC;IAErF,MAAM,iBAAiB,KAA6D,CAAC;CAC7F;AAED,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAKpE;AAED;;GAEG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,SAAM,GAAG,MAAM,CAS5D;AAID;;;;;GAKG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,CAQ5D;AAED;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,qBAAqB,CAAC,EAAE,OAAO,GAAG,MAAM,CAU1F;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAa3C;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5D;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAS9D;AAED;;;;GAIG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,SAAM,GAAG,MAAM,CAG3D;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAgB9D;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,CAMxE;AAED;;;;GAIG;AACH,wBAAgB,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CA2B9D;AAED,wBAAgB,2BAA2B,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEnE;AAED,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEtD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAgBpE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CASlE;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,wBAAgB,YAAY,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAE,aAAkB,GAAG,MAAM,CA8BxG;AAED,wBAAgB,wBAAwB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAWhE;AAED,wBAAgB,2BAA2B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAExE;AAED,wBAAgB,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAOlD;AAED;;;GAGG;AACH,wBAAgB,uBAAuB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQ3D;AAED;;;GAGG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,SAAI,EAAE,GAAG,GAAE,MAAmB,GAAG,MAAM,CAQ7F;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAE,MAAuB,GAAG,MAAM,CAQ/F;AAED,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAQpD;AAED,wBAAgB,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAuC9D;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD;AAED,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAExD;AAMD,wBAAgB,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,OAAO,CAS9D;AAgCD,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAO5E;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAW/D;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAc/D;AAaD;;;GAGG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAoBpD;AAiBD,wBAAgB,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAEzD;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAExD;AAQD;;GAEG;AACH,wBAAgB,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEhD;AAQD,wBAAgB,aAAa,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAElD;AAGD;;GAEG;AACH,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEjD;AAED,wBAAgB,0BAA0B,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAO/D;AAED,wBAAgB,oBAAoB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CA6C9D;AAED;;;GAGG;AACH,wBAAgB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,UAiB3C;AAQD,wBAAgB,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAQzD;AAED,eAAO,MAAM,aAAa,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAczC,CAAC;AAIL,eAAO,MAAM,kBAAkB,QAAyC,CAAC;AAEzE,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAEtD;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAMvD;AAED;;;GAGG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CA0BpE;AAED,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,MAAM,EAAE,kBAAkB,UAAQ,GAAG,OAAO,CAU9F;AAED,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAExD;AAED,wBAAgB,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,SAAI,GAAG,MAAM,CAYpD;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,aAAa,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,MAAM,CAEpF;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CASjF;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,CAiDlD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,MAAM,EAAE,UAAU,GAAG,MAAM,CA+CrD"}