## Usage ```javascript var Slice = require( '@stdlib/slice-ctor' ); ``` #### Slice( \[stop] ) Returns a `Slice` instance. ```javascript var s = new Slice(); // returns s = new Slice(); // returns ``` The constructor accepts the following arguments: - **stop**: ending index (exclusive). Default: `null`. #### Slice( start, stop\[, step] ) Returns a `Slice` instance. ```javascript var s = new Slice( 0, 10 ); // returns s = new Slice( 0, 10, 1 ); // returns ``` The constructor accepts the following arguments: - **start**: starting index (inclusive). - **stop**: ending index (exclusive). - **step**: index increment. A numeric index increment argument must be a non-zero integer value. Default: `null`. * * * ### Properties #### Slice.name String value of the `Slice` constructor name. ```javascript var str = Slice.name; // returns 'Slice' ``` #### Slice.prototype.start **Read-only** property returning the slice starting index. ```javascript var s = new Slice( 10 ); // returns var start = s.start; // returns null s = new Slice( 2, 10 ); // returns start = s.start; // returns 2 ``` #### Slice.prototype.stop **Read-only** property returning the slice ending index. ```javascript var s = new Slice( null ); // returns var stop = s.stop; // returns null s = new Slice( 10 ); // returns stop = s.stop; // returns 10 s = new Slice( 2, 10 ); // returns stop = s.stop; // returns 10 ``` #### Slice.prototype.step **Read-only** property returning the slice index increment. ```javascript var s = new Slice( 10 ); // returns var step = s.step; // returns null s = new Slice( 2, 10 ); // returns step = s.step; // returns null s = new Slice( 2, 10, 1 ); // returns step = s.step; // returns 1 ``` * * * ### Methods #### Slice.prototype.toString() Serializes a `Slice` as a string. ```javascript var s = new Slice( 10 ); // returns var str = s.toString(); // returns 'Slice(null,10,null)' s = new Slice( 2, 10, 1 ); // returns str = s.toString(); // returns 'Slice(2,10,1)' ``` #### Slice.prototype.toJSON() Serializes a `Slice` as a [JSON][json] object. ```javascript var s = new Slice( 10 ); // returns var o = s.toJSON(); // returns { 'type': 'Slice', 'data': [ null, 10, null ] } s = new Slice( 2, 10, 1 ); // returns o = s.toJSON(); // returns { 'type': 'Slice', 'data': [ 2, 10, 1 ] } ``` `JSON.stringify()` implicitly calls this method when stringifying a `Slice` instance.

## Examples ```javascript var Slice = require( '@stdlib/slice-ctor' ); var s = new Slice( 9, -10, -1 ); // returns var start = s.start; console.log( 'Start: %d', start ); // => 'Start: 9' var stop = s.stop; console.log( 'Stop: %d', stop ); // => 'Stop: -10' var step = s.step; console.log( 'Step: %d', step ); // => 'Step: -1' var str = s.toString(); console.log( str ); // => 'Slice(9,-10,-1)' var o = s.toJSON(); console.log( JSON.stringify( o ) ); // => '{"type":"Slice","data":[9,-10,-1]}' ```

* * * ## Notice This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2026. The Stdlib [Authors][stdlib-authors].

[npm-image]: http://img.shields.io/npm/v/@stdlib/slice-ctor.svg [npm-url]: https://npmjs.org/package/@stdlib/slice-ctor [test-image]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml/badge.svg?branch=v0.2.3 [test-url]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml?query=branch:v0.2.3 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/slice-ctor/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/slice-ctor?branch=main [chat-image]: https://img.shields.io/badge/zulip-join_chat-brightgreen.svg [chat-url]: https://stdlib.zulipchat.com [stdlib]: https://github.com/stdlib-js/stdlib [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors [umd]: https://github.com/umdjs/umd [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules [deno-url]: https://github.com/stdlib-js/slice-ctor/tree/deno [deno-readme]: https://github.com/stdlib-js/slice-ctor/blob/deno/README.md [umd-url]: https://github.com/stdlib-js/slice-ctor/tree/umd [umd-readme]: https://github.com/stdlib-js/slice-ctor/blob/umd/README.md [esm-url]: https://github.com/stdlib-js/slice-ctor/tree/esm [esm-readme]: https://github.com/stdlib-js/slice-ctor/blob/esm/README.md [branches-url]: https://github.com/stdlib-js/slice-ctor/blob/main/branches.md [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/slice-ctor/main/LICENSE [json]: http://www.json.org/ [@stdlib/ndarray]: https://www.npmjs.com/package/@stdlib/ndarray [@stdlib/ndarray/ctor]: https://www.npmjs.com/package/@stdlib/ndarray-ctor [@stdlib/slice/multi]: https://www.npmjs.com/package/@stdlib/slice-multi