@stdlib/slice-base-str2slice v0.2.1

str2slice

Parse a string-serialized Slice object.

Installation

npm install @stdlib/slice-base-str2slice

Usage

var str2slice = require( '@stdlib/slice-base-str2slice' );

str2slice( str )

Parses a string-serialized Slice object.

var s = str2slice( 'Slice(0,5,1)' );
// returns <Slice>

var v = s.start;
// returns 0

v = s.stop;
// returns 5

v = s.step;
// returns 1

The function returns null if provided an invalid string.

var s = str2slice( 'Slice(foo,bar)' );
// returns null

Notes

• The string serialization format must match that of a Slice object.

  var Slice = require( '@stdlib/slice-ctor' );
  
  var s = new Slice( 2, 10, 1 );
  // returns <Slice>
  
  var str = s.toString();
  // returns 'Slice(2,10,1)'

Examples

var str2slice = require( '@stdlib/slice-base-str2slice' );

var s = str2slice( 'Slice(null,null,null)' );
console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
// => 'start: null. stop: null. step: null.'

s = str2slice( 'Slice(2,10,2)' );
console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
// => 'start: 2. stop: 10. step: 2.'

s = str2slice( 'Slice(10,null,-2)' );
console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
// => 'start: 10. stop: null. step: -2.'

s = str2slice( 'Slice(null,null,2)' );
console.log( 'start: %s. stop: %s. step: %s.', s.start, s.stop, s.step );
// => 'start: null. stop: null. step: 2.'

s = str2slice( 'Slice(foo,bar)' );
console.log( s );
// => null

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

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.