time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

is_string.js (1177B)


      1 /**
      2 * @license Apache-2.0
      3 *
      4 * Copyright (c) 2022 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 * Tests if a value is a string primitive.
     23 *
     24 * @param {*} value - value to test
     25 * @returns {boolean} boolean indicating if a value is a string primitive
     26 *
     27 * @example
     28 * var bool = isString( 'beep' );
     29 * // returns true
     30 *
     31 * @example
     32 * var bool = isString( new String( 'beep' ) );
     33 * // returns false
     34 */
     35 function isString( value ) {
     36 	return ( typeof value === 'string' ); // NOTE: we inline the `isString.isPrimitive` function from `@stdlib/assert/is-string` in order to avoid circular dependencies.
     37 }
     38 
     39 
     40 // EXPORTS //
     41 
     42 module.exports = isString;