isWellFormedString

Test if a string is well-formed.

Usage

var isWellFormedString = require( '@stdlib/assert/is-well-formed-string' );

isWellFormedString( str )

Tests if a string is well-formed.

var bool = isWellFormedString( '' );
// returns true

bool = isWellFormedString( new String( '' ) );
// returns true

bool = isWellFormedString( '\uDBFF' );
// returns false

bool = isWellFormedString( '\uDBFFFF\uDBFF' );
// returns false

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

bool = isWellFormedString( '-5' );
// returns true

bool = isWellFormedString( null );
// returns false

isWellFormedString.isPrimitive( str )

Tests if a string is a well-formed string primitive.

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

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

isWellFormedString.isObject( str )

Tests if a string is a well-formed String object.

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

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

Examples

var isWellFormedString = require( '@stdlib/assert/is-well-formed-string' );

var bool = isWellFormedString( '' );
// returns true

bool = isWellFormedString( new String( '' ) );
// returns true

bool = isWellFormedString( '\uDBFF' );
// returns false

bool = isWellFormedString( '\uDBFF\uDBFF' );
// returns false

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

bool = isWellFormedString( '-5' );
// returns true

bool = isWellFormedString( null );
// returns false
Did you find this page helpful?