summaryrefslogtreecommitdiff
path: root/strings
diff options
context:
space:
mode:
authorVincent LE GOFF <g_n_s@hotmail.fr>2019-03-18 16:08:01 +0100
committerRyan Dahl <ry@tinyclouds.org>2019-03-18 11:08:01 -0400
commit2e1ed890b85d4ecf1a6332cf2e0c121d5640b496 (patch)
tree6675fa9c8ed42d3e2d85583f5be3ce6456f2af9c /strings
parentd1b0a1ef6c9cf0726687402bd12ce9ad4ead8424 (diff)
Documentation clean up (denoland/deno_std#288)
Original: https://github.com/denoland/deno_std/commit/b699fa67befaef4423f365e55eff0fec2e14def8
Diffstat (limited to 'strings')
-rw-r--r--strings/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/strings/README.md b/strings/README.md
new file mode 100644
index 000000000..8b41fee67
--- /dev/null
+++ b/strings/README.md
@@ -0,0 +1,26 @@
+# Strings
+
+This module provides a few basic utilities to manipulate strings.
+
+## Usage
+
+### pad
+
+Input string is processed to output a string with a minimal length.
+If the parameter `strict` is set to true, the output string length
+is equal to the `strLen` parameter.
+
+Basic usage:
+
+```ts
+import { pad } from "https://deno.land/std/strings/pad.ts";
+pad("deno", 6, { char: "*", side: "left" }) // output : "**deno"
+pad("deno", 6, { char: "*", side: "right"}) // output : "deno**"
+pad("denosorusrex", 6 {
+ char: "*",
+ side: "left",
+ strict: true,
+ strictSide: "right",
+ strictChar: "..."
+}) // output : "den..."
+```