summaryrefslogtreecommitdiff
path: root/deps/npm/node_modules/lodash/string/padLeft.js
diff options
context:
space:
mode:
Diffstat (limited to 'deps/npm/node_modules/lodash/string/padLeft.js')
-rw-r--r--deps/npm/node_modules/lodash/string/padLeft.js27
1 files changed, 27 insertions, 0 deletions
diff --git a/deps/npm/node_modules/lodash/string/padLeft.js b/deps/npm/node_modules/lodash/string/padLeft.js
new file mode 100644
index 0000000000..bb0c94d0cd
--- /dev/null
+++ b/deps/npm/node_modules/lodash/string/padLeft.js
@@ -0,0 +1,27 @@
+var createPadDir = require('../internal/createPadDir');
+
+/**
+ * Pads `string` on the left side if it's shorter than `length`. Padding
+ * characters are truncated if they exceed `length`.
+ *
+ * @static
+ * @memberOf _
+ * @category String
+ * @param {string} [string=''] The string to pad.
+ * @param {number} [length=0] The padding length.
+ * @param {string} [chars=' '] The string used as padding.
+ * @returns {string} Returns the padded string.
+ * @example
+ *
+ * _.padLeft('abc', 6);
+ * // => ' abc'
+ *
+ * _.padLeft('abc', 6, '_-');
+ * // => '_-_abc'
+ *
+ * _.padLeft('abc', 3);
+ * // => 'abc'
+ */
+var padLeft = createPadDir();
+
+module.exports = padLeft;