UNPKG

2.41 kBTypeScriptView Raw
1/*! *****************************************************************************
2Copyright (c) Microsoft Corporation. All rights reserved.
3Licensed under the Apache License, Version 2.0 (the "License"); you may not use
4this file except in compliance with the License. You may obtain a copy of the
5License at http://www.apache.org/licenses/LICENSE-2.0
6
7THIS CODE IS PROVIDED ON AN *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
8KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY IMPLIED
9WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR PURPOSE,
10MERCHANTABLITY OR NON-INFRINGEMENT.
11
12See the Apache Version 2.0 License for specific language governing permissions
13and limitations under the License.
14***************************************************************************** */
15
16
17
18/// <reference no-default-lib="true"/>
19
20
21interface String {
22 /**
23 * Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
24 * The padding is applied from the start (left) of the current string.
25 *
26 * @param maxLength The length of the resulting string once the current string has been padded.
27 * If this parameter is smaller than the current string's length, the current string will be returned as it is.
28 *
29 * @param fillString The string to pad the current string with.
30 * If this string is too long, it will be truncated and the left-most part will be applied.
31 * The default value for this parameter is " " (U+0020).
32 */
33 padStart(maxLength: number, fillString?: string): string;
34
35 /**
36 * Pads the current string with a given string (possibly repeated) so that the resulting string reaches a given length.
37 * The padding is applied from the end (right) of the current string.
38 *
39 * @param maxLength The length of the resulting string once the current string has been padded.
40 * If this parameter is smaller than the current string's length, the current string will be returned as it is.
41 *
42 * @param fillString The string to pad the current string with.
43 * If this string is too long, it will be truncated and the left-most part will be applied.
44 * The default value for this parameter is " " (U+0020).
45 */
46 padEnd(maxLength: number, fillString?: string): string;
47}