aboutsummaryrefslogtreecommitdiff
path: root/node_modules/param-case/README.md
diff options
context:
space:
mode:
authorruki <waruqi@gmail.com>2018-11-08 00:38:48 +0800
committerruki <waruqi@gmail.com>2018-11-07 21:53:09 +0800
commit26105034da4fcce7ac883c899d781f016559310d (patch)
treec459a5dc4e3aa0972d9919033ece511ce76dd129 /node_modules/param-case/README.md
parent2c77f00f1a7ecb6c8192f9c16d3b2001b254a107 (diff)
downloadxmake-docs-26105034da4fcce7ac883c899d781f016559310d.tar.gz
xmake-docs-26105034da4fcce7ac883c899d781f016559310d.zip
switch to vuepress
Diffstat (limited to 'node_modules/param-case/README.md')
-rw-r--r--node_modules/param-case/README.md45
1 files changed, 45 insertions, 0 deletions
diff --git a/node_modules/param-case/README.md b/node_modules/param-case/README.md
new file mode 100644
index 00000000..d32fc635
--- /dev/null
+++ b/node_modules/param-case/README.md
@@ -0,0 +1,45 @@
+# Param Case
+
+[![NPM version][npm-image]][npm-url]
+[![NPM downloads][downloads-image]][downloads-url]
+[![Build status][travis-image]][travis-url]
+[![Test coverage][coveralls-image]][coveralls-url]
+
+Param case a string.
+
+Supports Unicode (non-ASCII characters) and non-string entities, such as objects with a `toString` property, numbers and booleans. Empty values (`null` and `undefined`) will result in an empty string.
+
+## Installation
+
+```
+npm install param-case --save
+```
+
+## Usage
+
+```javascript
+var paramCase = require('param-case')
+
+paramCase('string') //=> "string"
+paramCase('camelCase') //=> "camel-case"
+paramCase('sentence case') //=> "sentence-case"
+
+paramCase('MY STRING', 'tr') //=> "my-strıng"
+```
+
+## Typings
+
+Includes a [TypeScript definition](param-case.d.ts).
+
+## License
+
+MIT
+
+[npm-image]: https://img.shields.io/npm/v/param-case.svg?style=flat
+[npm-url]: https://npmjs.org/package/param-case
+[downloads-image]: https://img.shields.io/npm/dm/param-case.svg?style=flat
+[downloads-url]: https://npmjs.org/package/param-case
+[travis-image]: https://img.shields.io/travis/blakeembrey/param-case.svg?style=flat
+[travis-url]: https://travis-ci.org/blakeembrey/param-case
+[coveralls-image]: https://img.shields.io/coveralls/blakeembrey/param-case.svg?style=flat
+[coveralls-url]: https://coveralls.io/r/blakeembrey/param-case?branch=master