lib.es2017.string.d.ts 2.4 KB

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