diff options
Diffstat (limited to 'node_modules/dedent/README.md')
-rw-r--r-- | node_modules/dedent/README.md | 59 |
1 files changed, 59 insertions, 0 deletions
diff --git a/node_modules/dedent/README.md b/node_modules/dedent/README.md new file mode 100644 index 0000000..af51323 --- /dev/null +++ b/node_modules/dedent/README.md @@ -0,0 +1,59 @@ +# Dedent + +An ES6 string tag that strips indentation from multi-line strings. + +## Usage + +```js +import dedent from "dedent"; + +function usageExample() { + const first = dedent`A string that gets so long you need to break it over + multiple lines. Luckily dedent is here to keep it + readable without lots of spaces ending up in the string + itself.`; + + const second = dedent` + Leading and trailing lines will be trimmed, so you can write something like + this and have it work as you expect: + + * how convenient it is + * that I can use an indented list + - and still have it do the right thing + + That's all. + `; + + const third = dedent(` + Wait! I lied. Dedent can also be used as a function. + `); + + return first + "\n\n" + second + "\n\n" + third; +} +``` + +```js +> console.log(usageExample()); +``` + +``` +A string that gets so long you need to break it over +multiple lines. Luckily dedent is here to keep it +readable without lots of spaces ending up in the string +itself. + +Leading and trailing lines will be trimmed, so you can write something like +this and have it work as you expect: + + * how convenient it is + * that I can use an indented list + - and still have it do the right thing + +That's all. + +Wait! I lied. Dedent can also be used as a function. +``` + +## License + +MIT |