# transform-string

> Transform any string using properties CSS like

Latest version **0.0.1** (published 2019-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install transform-string
pnpm add transform-string
yarn add transform-string
bun add transform-string
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2019-07-25 |
| First published | 2019-07-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 5.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Abraham Hernandez |
| Maintainers | abranhe |
| Keywords | transform, string, string-manipulation, truncate |

## Links

- npm: https://www.npmjs.com/package/transform-string
- Repository: https://github.com/abranhe/transform-string
- Homepage: https://github.com/abranhe/transform-string#readme
- Issues: https://github.com/abranhe/transform-string/issues
- npm.io page: https://npm.io/package/transform-string

## Alternatives

- [@mce/gif](https://npm.io/package/@mce/gif.md) — 2.6K weekly downloads
- [cleanse](https://npm.io/package/cleanse.md) — 173 weekly downloads
- [str](https://npm.io/package/str.md) — 127 weekly downloads
- [naming](https://npm.io/package/naming.md) — 95 weekly downloads
- [tap-telco-api](https://npm.io/package/tap-telco-api.md) — 19 weekly downloads

## Recent versions

- 0.0.1 (latest) — 2019-07-25

## README

# transform-string [![Build Status](https://travis-ci.com/abranhe/transform-string.svg?branch=master)](https://travis-ci.com/abranhe/transform-string)

> Transform any string using properties CSS like


## Install

```
$ npm install transform-string
```


## Usage

```js
const transformString = ('transform-string');

transformString('unicorns');
//=> 'Unicorns'

transformString.capitalize('hello world');
//=> 'Hello World'
```
or

```js
import transformString, { capitalize } from 'transform-string';

transformString('unicorns');
//=> 'Unicorns'

capitalize('hello world');
//=> 'Hello World'
```

## API

### transformString(input, [options])

#### input

Type: `string`

The input to be transformed

#### options

Type: `object`

##### type

Type: `string`<br>
Default: `title`

String transform type.

Types:

- `title`
- `capitalize`
- `lowercase`
- `uppercase`

### title(input)

#### input

Type: `string`

Capitalizes first letter of string

### capitalize(input)

#### input

Type: `string`

Capitalizes first letter of each word in string

### lowercase(input)

#### input

Type: `string`

Converts all to lowercase

### uppercase(input)

#### input

Type: `string`

Converts all to uppercase

## Related

- [capitalize-first-letters](https://github.com/abranhe/capitalize-first-letters) Capitalizes first letters of each word in string

## License

MIT © [Abraham Hernandez](https://abranhe.com)

---
_Source: https://npm.io/package/transform-string · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._