Merge pull request #9 from karlvr/types

Types

package.json

@@ -2,6 +2,7 @@
   "author": "Francois-Guillaume Ribreau <npm@fgribreau.com> (http://fgribreau.com)",
   "name": "truncate",
   "main": "truncate.js",
+  "types": "truncate.d.ts",
   "description": "Truncate text and keep urls safe",
   "version": "2.0.1",
   "homepage": "https://github.com/FGRibreau/node-truncate",

truncate.d.ts

@@ -0,0 +1,7 @@
+declare module 'truncate' {
+    interface TruncateOptions {
+        ellipsis?: string
+    }
+
+    export default function truncate(string: string, maxLength: number, options?: TruncateOptions): string
+}

truncate.js

@@ -25,7 +25,6 @@
      * @param {String} string string needs to be truncated
      * @param {Number} maxLength length of truncated string
      * @param {Object} options (optional)
-     * @param {Boolean} [options.keepImageTag] flag to specify if keep image tag, false by default
      * @param {Boolean|String} [options.ellipsis] omission symbol for truncated string, '...' by default
      * @return {String} truncated string
      */