summaryrefslogtreecommitdiff
path: root/std/strings/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'std/strings/README.md')
m---------std0
-rw-r--r--std/strings/README.md26
2 files changed, 26 insertions, 0 deletions
diff --git a/std b/std
deleted file mode 160000
-Subproject 43aafbf33285753e7b42230f0eb7969b300f71c
diff --git a/std/strings/README.md b/std/strings/README.md
new file mode 100644
index 000000000..2aad4357b
--- /dev/null
+++ b/std/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..."
+```