index.js (1246B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /** 22 * Test if a string starts with the characters of another string. 23 * 24 * @module @stdlib/string/starts-with 25 * 26 * @example 27 * var startsWith = require( '@stdlib/string/starts-with' ); 28 * 29 * var str = 'Fair is foul, and foul is fair, hover through fog and filthy air'; 30 * var bool = startsWith( str, 'Fair' ); 31 * // returns true 32 * 33 * bool = startsWith( str, 'fair' ); 34 * // returns false 35 * 36 * bool = startsWith( str, 'foul', 8 ); 37 * // returns true 38 * 39 * bool = startsWith( str, 'filthy', -10 ); 40 * // returns true 41 */ 42 43 // MODULES // 44 45 var startsWith = require( './starts_with.js' ); 46 47 48 // EXPORTS // 49 50 module.exports = startsWith;