source: node_modules/ramda-adjunct/es/padCharsStart.js

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 15 months ago

Initial commit

  • Property mode set to 100644
File size: 1.3 KB
Line 
1import { flip, invoker, curry } from 'ramda';
2import isFunction from './isFunction';
3import ponyfill from './internal/ponyfills/String.padStart';
4export var padStartInvoker = flip(invoker(2, 'padStart'));
5export var padStartPonyfill = curry(ponyfill);
6
7/**
8 * The function pads the current string with a given string
9 * (repeated, if needed) so that the resulting string reaches a given length.
10 * The padding is applied from the start of the current string.
11 *
12 * @func padCharsStart
13 * @memberOf RA
14 * @since {@link https://char0n.github.io/ramda-adjunct/2.22.0|v2.22.0}
15 * @category String
16 * @sig String -> Number -> String -> String
17 * @param {string} padString The string to pad the current string with
18 * @param {number} targetLength The length of the resulting string once the current string has been padded
19 * @param {string} value String value to be padded
20 * @return {string} A new string of the specified length with the pad string on the start of current string
21 * @see {@link RA.padStart|padStart}, {@link RA.padEnd|padEnd}, {@link RA.padCharsEnd|padCharsEnd}
22 * @example
23 *
24 * RA.padCharsStart('-', 3, 'a'); // => '--a'
25 * RA.padCharsStart('foo', 10, 'abc'); // => 'foofoofabc'
26 * RA.padCharsStart('123456', 6, 'abc'); // => '123abc'
27 */
28var padCharsStart = isFunction(String.prototype.padStart) ? padStartInvoker : padStartPonyfill;
29export default padCharsStart;
Note: See TracBrowser for help on using the repository browser.