aboutsummaryrefslogtreecommitdiff
path: root/node_modules/truncate-utf8-bytes/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/truncate-utf8-bytes/README.md')
-rw-r--r--node_modules/truncate-utf8-bytes/README.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/node_modules/truncate-utf8-bytes/README.md b/node_modules/truncate-utf8-bytes/README.md
new file mode 100644
index 0000000..098819e
--- /dev/null
+++ b/node_modules/truncate-utf8-bytes/README.md
@@ -0,0 +1,27 @@
+# truncate-utf8-bytes [![build status](https://secure.travis-ci.org/parshap/truncate-utf8-bytes.svg?branch=master)](http://travis-ci.org/parshap/truncate-utf8-bytes)
+
+Truncate a string to the given length in bytes. Correctly handles
+multi-byte characters and surrogate pairs.
+
+A browser implementation that doesn't use `Buffer.byteLength` is
+provided to minimize build size.
+
+## Example
+
+```js
+var truncate = require("truncate-utf8-bytes")
+var str = "a☃" // a = 1 byte, ☃ = 3 bytes
+console.log(truncate(str, 2))
+// -> "a"
+```
+
+## API
+
+### `var truncate = require("truncate-utf8-bytes")`
+
+*When using browserify or webpack*, this automatically resolves to an
+implementation that does not use `Buffer.byteLength`.
+
+### `truncate(string, length)`
+
+Returns `string` truncated to at most `length` bytes in length.