[@fav/text.trim-left][repo-url] [![NPM][npm-img]][npm-url] [![MIT License][mit-img]][mit-url] [![Build Status][travis-img]][travis-url] [![Build Status][appveyor-img]][appveyor-url] [![Coverage status][coverage-img]][coverage-url]

Removes leading white spaces or specified characters from a source string.

> "fav" is an abbreviation of "favorite" and also the acronym of "for all versions".
> This package is intended to support all Node.js versions and many browsers as possible.
> At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

``sh $ npm install --save @fav/text.trim-left`

NOTE: npm < 2.7.0 does not support scoped package, but even old version Node.js supports it. So when you use such older npm, you should download this package from [github.com][repo-url], and move it in node_modules/@fav/text.trim-left/ directory manually.

`Usage`

For Node.js:

`js var trimLeft = require('@fav/text.trim-left'); trimLeft(' abc '); // => 'abc ' trimLeft('_-abc--_-', '_-'); // => 'abc--_-'`

For Web browsers:

`html``

API

$3

Removes leading white spaces or chars from source.

NOTE: This function doesn't check data types of the arguments, and assumes that they are given as per the specific data types.

#### Parameters:

| Parameter | Type | Description |
|-----------|:------:|--------------------|
| source | string | The source string. |
| chars | string | The characters to be trimmed. (Optional, and white space in default.) |

#### Return:

The trimmed string.

Type: string

Checked

$3

| Platform | 4 | 5 | 6 | 7 | 8 | 9 | 10 |
|:---------:|:------:|:------:|:------:|:------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|◯|◯|◯|◯|
| Windows10 |◯|◯|◯|◯|◯|◯|◯|
| Linux |◯|◯|◯|◯|◯|◯|◯|

$3

| Platform | 1 | 2 | 3 |
|:---------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|
| Windows10 |◯|◯|◯|
| Linux |◯|◯|◯|

$3

| Platform | 0.8 | 0.9 | 0.10 | 0.11 | 0.12 |
|:---------:|:------:|:------:|:------:|:------:|:------:|
| macOS |◯|◯|◯|◯|◯|
| Windows10 |◯|◯|◯|◯|◯|
| Linux |◯|◯|◯|◯|◯|

$3

| Platform | Chrome | Firefox | Vivaldi | Safari | Edge | IE11 |
|:---------:|:------:|:-------:|:-------:|:------:|:------:|:------:|
| macOS |◯|◯ |◯ |◯| -- | -- |
| Windows10 |◯|◯ |◯ | -- |◯|◯|
| Linux |◯|◯ |◯ | -- | -- | -- |

License

This program is free software under [MIT][mit-url] License.
See the file LICENSE in this distribution for more details.

[repo-url]: https://github.com/sttk/fav-text.trim-left/
[npm-img]: https://img.shields.io/badge/npm-v1.0.2-blue.svg
[npm-url]: https://www.npmjs.com/package/@fav/text.trim-left
[mit-img]: https://img.shields.io/badge/license-MIT-green.svg
[mit-url]: https://opensource.org/licenses/MIT
[travis-img]: https://travis-ci.org/sttk/fav-text.trim-left.svg?branch=master
[travis-url]: https://travis-ci.org/sttk/fav-text.trim-left
[appveyor-img]: https://ci.appveyor.com/api/projects/status/github/sttk/fav-text.trim-left?branch=master&svg=true
[appveyor-url]: https://ci.appveyor.com/project/sttk/fav-text-trim-left
[coverage-img]: https://coveralls.io/repos/github/sttk/fav-text.trim-left/badge.svg?branch=master
[coverage-url]: https://coveralls.io/github/sttk/fav-text.trim-left?branch=master