start-with
Version:
Determines whether a string begins with the characters of another string.
52 lines (29 loc) • 1.8 kB
Markdown
# start-with <sup>[](https://npmjs.org/package/start-with)</sup>
> Determines whether a string begins with the characters of another string.
> ES2015 [String#startsWith()](http://www.ecma-international.org/ecma-262/6.0/#sec-string.prototype.startswith) ponyfill.
> Ponyfill: A polyfill that doesn't overwrite the native method.
[](https://github.com/gearcase/start-with/blob/master/LICENSE)
[](https://travis-ci.org/gearcase/start-with)
[](https://coveralls.io/github/gearcase/start-with)
## Install
```
$ npm install --save start-with
```
## Usage
> For more use-cases see the [tests](https://github.com/gearcase/start-with/blob/master/test/spec/index.js)
```js
var startWith = require('start-with');
startWith('abcde', 'a'); // => true
startWith('abcde', 'ab'); // => true
startWith('abcde', 'bc'); // => false
startWith('abcde', ''); // => true
startWith('abcde'); // => false
startWith('abcde', null); // => false
```
## Related
- [end-with](https://github.com/gearcase/end-with) - Determines whether a string ends with the characters of another string.
- [pad-start](https://github.com/gearcase/pad-start) - ES spec-compliant String.prototype.padStart shim.
- [pad-end](https://github.com/gearcase/pad-end) - ES spec-compliant String.prototype.padEnd shim.
## Contributing
Pull requests and stars are highly welcome.
For bugs and feature requests, please [create an issue](https://github.com/gearcase/start-with/issues).