About stdlib...
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!
startsWith
Test if a string starts with the characters of another string.
Installation
npm install @stdlib/string-starts-with
Usage
var startsWith = require( '@stdlib/string-starts-with' );
startsWith( str, search[, position] )
Tests if a string starts with the characters of another string.
var str = 'To be, or not to be, that is the question.';
var bool = startsWith( str, 'To be' );
bool = startsWith( str, 'to be' );
By default, the function searches from the beginning of the input string. To search from a different character index, provide a position
value (zero-based). If provided a negative position
, the start index is determined relative to the string end (i.e., pos = str.length + position
).
var str = 'Remember the story I used to tell you when you were a boy?';
var bool = startsWith( str, 'the story' );
bool = startsWith( str, 'the story', 9 );
bool = startsWith( str, 'you', -15 );
If provided an empty search
string, the function always returns true
.
var str = 'beep boop';
var bool = startsWith( str, '' );
Examples
var startsWith = require( '@stdlib/string-starts-with' );
var str = 'Fair is foul, and foul is fair, hover through fog and filthy air';
var bool = startsWith( str, 'Fair' );
bool = startsWith( str, 'fair' );
bool = startsWith( str, 'foul', 8 );
bool = startsWith( str, 'filthy', -10 );
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.