{"id":28411294,"url":"https://github.com/stdlib-js/slice-ctor","last_synced_at":"2025-06-25T10:31:13.062Z","repository":{"id":196236180,"uuid":"694656349","full_name":"stdlib-js/slice-ctor","owner":"stdlib-js","description":"Slice constructor.","archived":false,"fork":false,"pushed_at":"2025-06-23T01:16:21.000Z","size":366,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-06-23T02:22:46.953Z","etag":null,"topics":["constructor","constructors","ctor","ctors","data","javascript","node","node-js","nodejs","python","slice","stdlib","structure","types"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2023-09-21T12:38:25.000Z","updated_at":"2025-06-23T01:01:55.000Z","dependencies_parsed_at":null,"dependency_job_id":"839492fe-619e-4769-9eb5-8d06d5fe0be5","html_url":"https://github.com/stdlib-js/slice-ctor","commit_stats":{"total_commits":21,"total_committers":1,"mean_commits":21.0,"dds":0.0,"last_synced_commit":"811eba94d4b1d8d9fe348eb398d76d7de2539914"},"previous_names":["stdlib-js/slice-ctor"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/stdlib-js/slice-ctor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-ctor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-ctor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-ctor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-ctor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/slice-ctor/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fslice-ctor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261398286,"owners_count":23152639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["constructor","constructors","ctor","ctors","data","javascript","node","node-js","nodejs","python","slice","stdlib","structure","types"],"created_at":"2025-06-02T15:12:40.474Z","updated_at":"2025-06-25T10:31:13.055Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2023 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe 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.\u003c/p\u003e\n  \u003cp\u003eThe 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.\u003c/p\u003e\n  \u003cp\u003eWhen 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.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# Slice\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Slice constructor.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/slice-ctor\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar Slice = require( '@stdlib/slice-ctor' );\n```\n\n\u003ca name=\"main\"\u003e\u003c/a\u003e\n\n#### Slice( \\[stop] )\n\nReturns a `Slice` instance.\n\n```javascript\nvar s = new Slice();\n// returns \u003cSlice\u003e\n\ns = new Slice();\n// returns \u003cSlice\u003e\n```\n\nThe constructor accepts the following arguments:\n\n-   **stop**: ending index (exclusive). Default: `null`.\n\n#### Slice( start, stop\\[, step] )\n\nReturns a `Slice` instance.\n\n```javascript\nvar s = new Slice( 0, 10 );\n// returns \u003cSlice\u003e\n\ns = new Slice( 0, 10, 1 );\n// returns \u003cSlice\u003e\n```\n\nThe constructor accepts the following arguments:\n\n-   **start**: starting index (inclusive).\n-   **stop**: ending index (exclusive).\n-   **step**: index increment. A numeric index increment argument must be a non-zero integer value. Default: `null`.\n\n* * *\n\n### Properties\n\n\u003ca name=\"static-prop-name\"\u003e\u003c/a\u003e\n\n#### Slice.name\n\nString value of the `Slice` constructor name.\n\n```javascript\nvar str = Slice.name;\n// returns 'Slice'\n```\n\n\u003ca name=\"prop-start\"\u003e\u003c/a\u003e\n\n#### Slice.prototype.start\n\n**Read-only** property returning the slice starting index.\n\n```javascript\nvar s = new Slice( 10 );\n// returns \u003cSlice\u003e\n\nvar start = s.start;\n// returns null\n\ns = new Slice( 2, 10 );\n// returns \u003cSlice\u003e\n\nstart = s.start;\n// returns 2\n```\n\n\u003ca name=\"prop-stop\"\u003e\u003c/a\u003e\n\n#### Slice.prototype.stop\n\n**Read-only** property returning the slice ending index.\n\n\u003c!-- eslint-disable no-global-assign, stdlib/no-redeclare --\u003e\n\n```javascript\nvar s = new Slice( null );\n// returns \u003cSlice\u003e\n\nvar stop = s.stop;\n// returns null\n\ns = new Slice( 10 );\n// returns \u003cSlice\u003e\n\nstop = s.stop;\n// returns 10\n\ns = new Slice( 2, 10 );\n// returns \u003cSlice\u003e\n\nstop = s.stop;\n// returns 10\n```\n\n\u003ca name=\"prop-step\"\u003e\u003c/a\u003e\n\n#### Slice.prototype.step\n\n**Read-only** property returning the slice index increment.\n\n```javascript\nvar s = new Slice( 10 );\n// returns \u003cSlice\u003e\n\nvar step = s.step;\n// returns null\n\ns = new Slice( 2, 10 );\n// returns \u003cSlice\u003e\n\nstep = s.step;\n// returns null\n\ns = new Slice( 2, 10, 1 );\n// returns \u003cSlice\u003e\n\nstep = s.step;\n// returns 1\n```\n\n* * *\n\n### Methods\n\n\u003ca name=\"method-to-string\"\u003e\u003c/a\u003e\n\n#### Slice.prototype.toString()\n\nSerializes a `Slice` as a string.\n\n```javascript\nvar s = new Slice( 10 );\n// returns \u003cSlice\u003e\n\nvar str = s.toString();\n// returns 'Slice(null,10,null)'\n\ns = new Slice( 2, 10, 1 );\n// returns \u003cSlice\u003e\n\nstr = s.toString();\n// returns 'Slice(2,10,1)'\n```\n\n\u003ca name=\"method-to-json\"\u003e\u003c/a\u003e\n\n#### Slice.prototype.toJSON()\n\nSerializes a `Slice` as a [JSON][json] object.\n\n```javascript\nvar s = new Slice( 10 );\n// returns \u003cSlice\u003e\n\nvar o = s.toJSON();\n// returns { 'type': 'Slice', 'data': [ null, 10, null ] }\n\ns = new Slice( 2, 10, 1 );\n// returns \u003cSlice\u003e\n\no = s.toJSON();\n// returns { 'type': 'Slice', 'data': [ 2, 10, 1 ] }\n```\n\n`JSON.stringify()` implicitly calls this method when stringifying a `Slice` instance.\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n* * *\n\n\u003csection class=\"notes\"\u003e\n\n## Notes\n\n-   Slice arguments may be either integers, `null`, or `undefined`, where a non-integer value indicates a slice parameter which should be determined based on the slice context (e.g., when used to index into an [`ndarray`][@stdlib/ndarray/ctor]).\n-   Slice instances have no explicit functionality; however, they are used by [`ndarray`][@stdlib/ndarray] and other packages for creating views into multi-dimensional data structures.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n* * *\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n\u003c!-- eslint-disable no-global-assign, stdlib/no-redeclare --\u003e\n\n```javascript\nvar Slice = require( '@stdlib/slice-ctor' );\n\nvar s = new Slice( 9, -10, -1 );\n// returns \u003cSlice\u003e\n\nvar start = s.start;\nconsole.log( 'Start: %d', start );\n// =\u003e 'Start: 9'\n\nvar stop = s.stop;\nconsole.log( 'Stop: %d', stop );\n// =\u003e 'Stop: -10'\n\nvar step = s.step;\nconsole.log( 'Step: %d', step );\n// =\u003e 'Step: -1'\n\nvar str = s.toString();\nconsole.log( str );\n// =\u003e 'Slice(9,-10,-1)'\n\nvar o = s.toJSON();\nconsole.log( JSON.stringify( o ) );\n// =\u003e '{\"type\":\"Slice\",\"data\":[9,-10,-1]}'\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n* * *\n\n## See Also\n\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/ndarray-ctor`][@stdlib/ndarray/ctor]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003emultidimensional array constructor.\u003c/span\u003e\n-   \u003cspan class=\"package-name\"\u003e[`@stdlib/slice-multi`][@stdlib/slice/multi]\u003c/span\u003e\u003cspan class=\"delimiter\"\u003e: \u003c/span\u003e\u003cspan class=\"description\"\u003emulti-slice constructor.\u003c/span\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis 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.\n\nFor 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].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2025. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/slice-ctor.svg\n[npm-url]: https://npmjs.org/package/@stdlib/slice-ctor\n\n[test-image]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/slice-ctor/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/slice-ctor/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/slice-ctor?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/slice-ctor.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/slice-ctor/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/slice-ctor/tree/deno\n[deno-readme]: https://github.com/stdlib-js/slice-ctor/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/slice-ctor/tree/umd\n[umd-readme]: https://github.com/stdlib-js/slice-ctor/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/slice-ctor/tree/esm\n[esm-readme]: https://github.com/stdlib-js/slice-ctor/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/slice-ctor/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/slice-ctor/main/LICENSE\n\n[json]: http://www.json.org/\n\n[@stdlib/ndarray]: https://github.com/stdlib-js/ndarray\n\n[@stdlib/ndarray/ctor]: https://github.com/stdlib-js/ndarray-ctor\n\n\u003c!-- \u003crelated-links\u003e --\u003e\n\n[@stdlib/slice/multi]: https://github.com/stdlib-js/slice-multi\n\n\u003c!-- \u003c/related-links\u003e --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fslice-ctor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fslice-ctor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fslice-ctor/lists"}