Meta tweaks

Author: sindresorhus

index.d.ts

@@ -1,4 +1,15 @@
 /**
-Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code).
+Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string.
+
+@example
+```
+import stripAnsi from 'strip-ansi';
+
+stripAnsi('\u001B[4mUnicorn\u001B[0m');
+//=> 'Unicorn'
+
+stripAnsi('\u001B]8;;https://github.com\u0007Click\u001B]8;;\u0007');
+//=> 'Click'
+```
 */
-export default function stripAnsi(str: string): string;
+export default function stripAnsi(string: string): string;

index.js

@@ -1,7 +1,7 @@
 'use strict';
 const ansiRegex = require('ansi-regex');
 
-const stripAnsi = input => typeof input === 'string' ? input.replace(ansiRegex(), '') : input;
+const stripAnsi = string => typeof string === 'string' ? string.replace(ansiRegex(), '') : string;
 
 module.exports = stripAnsi;
 module.exports.default = stripAnsi;

index.test-d.ts

@@ -1,4 +1,4 @@
 import {expectType} from 'tsd-check';
 import stripAnsi from '.';
 
-expectType<string>(stripAnsi('\u001b[4mcake\u001b[0m'));
+expectType<string>(stripAnsi('\u001B[4mcake\u001B[0m'));

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "strip-ansi",
 	"version": "5.1.0",
-	"description": "Strip ANSI escape codes",
+	"description": "Strip ANSI escape codes from a string",
 	"license": "MIT",
 	"repository": "chalk/strip-ansi",
 	"author": {

readme.md

@@ -1,6 +1,6 @@
 # strip-ansi [![Build Status](https://travis-ci.org/chalk/strip-ansi.svg?branch=master)](https://travis-ci.org/chalk/strip-ansi)
 
-> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code)
+> Strip [ANSI escape codes](https://en.wikipedia.org/wiki/ANSI_escape_code) from a string
 
 ---