@stdlib/assert-is-string
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

isString

NPM version Build Status Coverage Status

Test if a value is a string.

Installation

npm install @stdlib/assert-is-string

Usage

var isString = require( '@stdlib/assert-is-string' );

isString( value )

Tests if a value is a string.

var bool = isString( 'beep' );
// returns true

bool = isString( new String( 'beep' ) );
// returns true

isString.isPrimitive( value )

Tests if a value is a primitive string.

var bool = isString.isPrimitive( 'beep' );
// returns true

bool = isString.isPrimitive( new String( 'boop' ) );
// returns false

isString.isObject( value )

Tests if a value is a String object.

var bool = isString.isObject( 'beep' );
// returns false

bool = isString.isObject( new String( 'boop' ) );
// returns true

Examples

var isString = require( '@stdlib/assert-is-string' );

var bool = isString( 'beep' );
// returns true

bool = isString( new String( 'beep' ) );
// returns true

bool = isString( 5 );
// returns false

bool = isString( null );
// returns false

bool = isString( void 0 );
// returns false

bool = isString( {} );
// returns false

bool = isString( [] );
// returns false

bool = isString( function foo() {} );
// returns false

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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/assert-is-string

Homepage

stdlib.io

Weekly Downloads

2,004,092

Version

0.2.1

License

Apache-2.0

Unpacked Size

38.3 kB

Total Files

15

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser