@stdlib/string-ends-with 0.0.8 → 0.1.0

package/CITATION.cff

@@ -0,0 +1,30 @@
+cff-version: 1.2.0
+title: stdlib
+message: >-
+  If you use this software, please cite it using the
+  metadata from this file.
+
+type: software
+
+authors:
+  - name: The Stdlib Authors
+    url: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+repository-code: https://github.com/stdlib-js/stdlib
+url: https://stdlib.io
+
+abstract: |
+  Standard library for JavaScript and Node.js.
+
+keywords:
+  - JavaScript
+  - Node.js
+  - TypeScript
+  - standard library
+  - scientific computing
+  - numerical computing
+  - statistical computing
+
+license: Apache-2.0 AND BSL-1.0
+
+date-released: 2016

package/LICENSE

@@ -175,307 +175,3 @@
       of your accepting any such warranty or additional liability.
 
    END OF TERMS AND CONDITIONS
-
-
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by this
-license (the "Software") to use, reproduce, display, distribute, execute, and
-transmit the Software, and to prepare derivative works of the Software, and to
-permit third-parties to whom the Software is furnished to do so, all subject to
-the following:
-
-The copyright notices in the Software and this entire statement, including the
-above license grant, this restriction and the following disclaimer, must be
-included in all copies of the Software, in whole or in part, and all derivative
-works of the Software, unless such copies or derivative works are solely in the
-form of machine-executable object code generated by a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
-FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
-OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
-OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-
-
-DEPENDENCIES
-
-The library links against the following external libraries, which have their own
-licenses:
-
-* OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
-def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
-
-Copyright (c) 2011-2014, The OpenBLAS Project
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   1. Redistributions of source code must retain the above copyright
-      notice, this list of conditions and the following disclaimer.
-
-   2. Redistributions in binary form must reproduce the above copyright
-      notice, this list of conditions and the following disclaimer in
-      the documentation and/or other materials provided with the
-      distribution.
-
-   3. Neither the name of the OpenBLAS project nor the names of
-      its contributors may be used to endorse or promote products
-      derived from this software without specific prior written
-      permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
-LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
-CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
-GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
-THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* Electron <https://raw.githubusercontent.com/electron/electron/
-c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
-
-Copyright (c) 2013-2017 GitHub Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* Boost <http://www.boost.org/LICENSE_1_0.txt>
-
-Boost Software License - Version 1.0 - August 17th, 2003
-
-Permission is hereby granted, free of charge, to any person or organization
-obtaining a copy of the software and accompanying documentation covered by
-this license (the "Software") to use, reproduce, display, distribute,
-execute, and transmit the Software, and to prepare derivative works of the
-Software, and to permit third-parties to whom the Software is furnished to
-do so, all subject to the following:
-
-The copyright notices in the Software and this entire statement, including
-the above license grant, this restriction and the following disclaimer,
-must be included in all copies of the Software, in whole or in part, and
-all derivative works of the Software, unless such copies or derivative
-works are solely in the form of machine-executable object code generated by
-a source language processor.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
-SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
-FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
-ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
-DEALINGS IN THE SOFTWARE.
-
-
-* Cephes <http://www.netlib.org/cephes/readme>
-
-Copyright (c) 1984-2000 Stephen L. Moshier
-
-Some software in this archive may be from the book _Methods and Programs for
-Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
-or from the Cephes Mathematical Library, a commercial product. In either event,
-it is copyrighted by the author. What you see here may be used freely but it
-comes with no support or guarantee.
-
-Stephen L. Moshier
-moshier@na-net.ornl.gov
-
-
-
-ATTRIBUTION
-
-The library contains implementations from the following external libraries,
-which have their own licenses:
-
-* FreeBSD <https://svnweb.freebsd.org/>
-
-Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* FDLIBM <http://www.netlib.org/fdlibm/>
-
-Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
-
-Developed at SunPro, a Sun Microsystems, Inc. business.
-Permission to use, copy, modify, and distribute this
-software is freely granted, provided that this notice
-is preserved.
-
-
-* Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
-
-Copyright (c) 2009 The Go Authors. All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are
-met:
-
-   * Redistributions of source code must retain the above copyright
-notice, this list of conditions and the following disclaimer.
-   * Redistributions in binary form must reproduce the above
-copyright notice, this list of conditions and the following disclaimer
-in the documentation and/or other materials provided with the
-distribution.
-   * Neither the name of Google Inc. nor the names of its
-contributors may be used to endorse or promote products derived from
-this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
-
-* SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
-
-Public domain.
-
-
-* ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
-
-Copyright JS Foundation and other contributors, https://js.foundation
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
-
-
-* StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
-e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
-
-Copyright (c) 2015: Dahua Lin.
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
-* SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
-SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
-
-The MIT License (MIT)
-
-Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
-
-https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
-
-
-* MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
-mt19937ar.c>
-
-Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-
- 1. Redistributions of source code must retain the above copyright
-    notice, this list of conditions and the following disclaimer.
-
- 2. Redistributions in binary form must reproduce the above copyright
-    notice, this list of conditions and the following disclaimer in the
-    documentation and/or other materials provided with the distribution.
-
- 3. The names of its contributors may not be used to endorse or promote
-    products derived from this software without specific prior written
-    permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT
-OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2022 The Stdlib Authors.
+Copyright (c) 2016-2023 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>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.</p>
+  <p>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.</p>
+  <p>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.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # endsWith
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -50,7 +61,7 @@ var endsWith = require( '@stdlib/string-ends-with' );
 
 #### endsWith( str, search\[, len] )
 
-Tests if a `string` ends with the characters of another `string`.
+Tests if a string ends with the characters of another string.
 
 ```javascript
 var str = 'Remember the story I used to tell you when you were a boy?';
@@ -87,6 +98,27 @@ var bool = endsWith( str, '' );
 
 <!-- /.usage -->
 
+<section class="notes">
+
+## Notes
+
+-   In general, exercise caution when operating on substrings containing Unicode characters, as the visual character length may not equal the number of code points. For example,
+
+    ```javascript
+    var len = '🏠'.length;
+    // returns 2
+    ```
+
+-   This function differs from [`String.prototype.endsWith`][mdn-string-endswith] in the following ways:
+
+    -   The function requires string values for the first and second arguments and requires that the `len` argument is an integer value.
+    -   The function does **not** clamp positive `len` values to the end of the input string.
+    -   Except when provided an empty `search` string, the function **always** returns `false` is a `len` resolves to a starting search position which exceeds the bounds of the input string.
+
+</section>
+
+<!-- /.notes -->
+
 <section class="examples">
 
 ## Examples
@@ -96,12 +128,9 @@ var bool = endsWith( str, '' );
 ```javascript
 var endsWith = require( '@stdlib/string-ends-with' );
 
-var bool;
-var str;
-
-str = 'Fair is foul, and foul is fair, hover through fog and filthy air';
+var str = 'Fair is foul, and foul is fair, hover through fog and filthy air';
 
-bool = endsWith( str, 'air' );
+var bool = endsWith( str, 'air' );
 // returns true
 
 bool = endsWith( str, 'fair' );
@@ -118,111 +147,16 @@ bool = endsWith( str, 'fair', -34 );
 
 <!-- /.examples -->
 
-* * *
-
-<section class="cli">
-
-## CLI
-
-<section class="installation">
-
-## Installation
-
-To use the module as a general utility, install the module globally
-
-```bash
-npm install -g @stdlib/string-ends-with
-```
-
-</section>
-
-<!-- CLI usage documentation. -->
-
-<section class="usage">
-
-### Usage
-
-```text
-Usage: ends-with [options] --search=<string> [<string>]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-         --search string       Search string.
-         --len int             Substring length.
-         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.
-```
-
-</section>
-
-<!-- /.usage -->
-
-<!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
-
-<section class="notes">
-
-### Notes
-
--   If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.
-
-    ```bash
-    # Not escaped...
-    $ echo -n $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\r?\n/
-
-    # Escaped...
-    $ echo -n $'Hello, World!\nBeep Boop Baz' | ends-with --search=Beep --split /\\r?\\n/
-    ```
-
--   The implementation ignores trailing delimiters.
-
-</section>
-
-</section>
-
-<!-- /.notes -->
-
-<section class="examples">
-
-### Examples
-
-```bash
-$ ends-with --search=ep beep
-true
-```
-
-To use as a [standard stream][standard-streams],
-
-```bash
-$ echo -n 'boop' | ends-with --search=ep
-false
-```
-
-By default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.
-
-```bash
-$ echo -n 'Hello, World!\tBeep Boop' | ends-with --search=Boop --split '\t'
-false
-true
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
 
-<!-- /.cli -->
 
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">
 
-* * *
-
 ## See Also
 
--   <span class="package-name">[`@stdlib/string/starts-with`][@stdlib/string/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
+-   <span class="package-name">[`@stdlib/string-ends-with-cli`][@stdlib/string-ends-with-cli]</span><span class="delimiter">: </span><span class="description">CLI package for use as a command-line utility.</span>
+-   <span class="package-name">[`@stdlib/string-starts-with`][@stdlib/string/starts-with]</span><span class="delimiter">: </span><span class="description">test if a string starts with the characters of another string.</span>
 
 </section>
 
@@ -254,7 +188,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -264,11 +198,13 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 <section class="links">
 
+[@stdlib/string-ends-with-cli]: https://www.npmjs.com/package/@stdlib/string-ends-with-cli
+
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-ends-with.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-ends-with
 
-[test-image]: https://github.com/stdlib-js/string-ends-with/actions/workflows/test.yml/badge.svg
-[test-url]: https://github.com/stdlib-js/string-ends-with/actions/workflows/test.yml
+[test-image]: https://github.com/stdlib-js/string-ends-with/actions/workflows/test.yml/badge.svg?branch=v0.1.0
+[test-url]: https://github.com/stdlib-js/string-ends-with/actions/workflows/test.yml?query=branch:v0.1.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-ends-with/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-ends-with?branch=main
@@ -280,19 +216,24 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 -->
 
+[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
+
+[stdlib]: https://github.com/stdlib-js/stdlib
+
+[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+
+[cli-section]: https://github.com/stdlib-js/string-ends-with#cli
+[cli-url]: https://github.com/stdlib-js/string-ends-with/tree/cli
+[@stdlib/string-ends-with]: https://github.com/stdlib-js/string-ends-with/tree/main
+
 [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/string-ends-with/tree/deno
 [umd-url]: https://github.com/stdlib-js/string-ends-with/tree/umd
 [esm-url]: https://github.com/stdlib-js/string-ends-with/tree/esm
-
-[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
-
-[stdlib]: https://github.com/stdlib-js/stdlib
-
-[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
+[branches-url]: https://github.com/stdlib-js/string-ends-with/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-ends-with/main/LICENSE
 
@@ -300,6 +241,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
 
 [mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
 
+[mdn-string-endswith]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/endsWith
+
 <!-- <related-links> -->
 
 [@stdlib/string/starts-with]: https://www.npmjs.com/package/@stdlib/string-starts-with

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+/// <reference path="../docs/types/index.d.ts" />
+import endsWith from '../docs/types/index';
+export = endsWith;

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";var s=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var u=s(function(f,a){
+var g=require('@stdlib/assert-is-integer/dist').isPrimitive,n=require('@stdlib/assert-is-string/dist').isPrimitive,t=require('@stdlib/error-tools-fmtprodmsg/dist'),m=require('@stdlib/string-base-ends-with/dist');function o(e,r,i){if(!n(e))throw new TypeError(t('1Od3F',e));if(!n(r))throw new TypeError(t('1Od39',r));if(arguments.length>2){if(!g(i))throw new TypeError(t('1Od2z',i))}else i=e.length;return m(e,r,i)}a.exports=o
+});var v=u();module.exports=v;
+/** @license Apache-2.0 */
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\nvar base = require( '@stdlib/string-base-ends-with' );\n\n\n// MAIN //\n\n/**\n* Test if a string ends with the characters of another string.\n*\n* @param {string} str - input string\n* @param {string} search - search string\n* @param {integer} [len=str.length] - substring length\n* @throws {TypeError} first argument must be a string\n* @throws {TypeError} second argument must be a string\n* @throws {TypeError} third argument must be an integer\n* @returns {boolean} boolean indicating if the input string ends with the search string\n*\n* @example\n* var bool = endsWith( 'Remember the story I used to tell you when you were a boy?', 'boy?' );\n* // returns true\n*\n* @example\n* var bool = endsWith( 'Remember the story I used to tell you when you were a boy?', 'Boy?' );\n* // returns false\n*\n* @example\n* var bool = endsWith( 'To be, or not to be, that is the question.', 'to be' );\n* // returns false\n*\n* @example\n* var bool = endsWith( 'To be, or not to be, that is the question.', 'to be', 19 );\n* // returns true\n*\n* @example\n* var bool = endsWith( 'To be, or not to be, that is the question.', 'to be', -23 );\n* // returns true\n*/\nfunction endsWith( str, search, len ) {\n\tif ( !isString( str ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );\n\t}\n\tif ( !isString( search ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a string. Value: `%s`.', search ) );\n\t}\n\tif ( arguments.length > 2 ) {\n\t\tif ( !isInteger( len ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an integer. Value: `%s`.', len ) );\n\t\t}\n\t} else {\n\t\tlen = str.length;\n\t}\n\treturn base( str, search, len );\n}\n\n\n// EXPORTS //\n\nmodule.exports = endsWith;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Test if a string ends with the characters of another string.\n*\n* @module @stdlib/string-ends-with\n*\n* @example\n* var endsWith = require( '@stdlib/string-ends-with' );\n*\n* var str = 'Fair is foul, and foul is fair, hover through fog and filthy air';\n*\n* var bool = endsWith( str, 'air' );\n* // returns true\n*\n* bool = endsWith( str, 'fair' );\n* // returns false\n*\n* bool = endsWith( str, 'fair', 30 );\n* // returns true\n*\n* bool = endsWith( str, 'fair', -34 );\n* // returns true\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,QAAS,+BAAgC,EAoCpD,SAASC,EAAUC,EAAKC,EAAQC,EAAM,CACrC,GAAK,CAACN,EAAUI,CAAI,EACnB,MAAM,IAAI,UAAWH,EAAQ,kEAAmEG,CAAI,CAAE,EAEvG,GAAK,CAACJ,EAAUK,CAAO,EACtB,MAAM,IAAI,UAAWJ,EAAQ,mEAAoEI,CAAO,CAAE,EAE3G,GAAK,UAAU,OAAS,GACvB,GAAK,CAACN,EAAWO,CAAI,EACpB,MAAM,IAAI,UAAWL,EAAQ,oEAAqEK,CAAI,CAAE,OAGzGA,EAAMF,EAAI,OAEX,OAAOF,EAAME,EAAKC,EAAQC,CAAI,CAC/B,CAKAR,EAAO,QAAUK,ICpCjB,IAAII,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_main", "__commonJSMin", "exports", "module", "isInteger", "isString", "format", "base", "endsWith", "str", "search", "len", "main"]
+}

package/docs/types/index.d.ts

@@ -16,10 +16,14 @@
 * limitations under the License.
 */
 
-// TypeScript Version: 2.0
+// TypeScript Version: 4.1
 
 /**
-* Test if a string ends with the characters of another string.
+* Tests if a string ends with the characters of another string.
+*
+* ## Notes
+*
+* -   The last parameter restricts the search to a substring within the input string beginning from the leftmost character. If provided a negative value, `len` indicates to ignore the last `len` characters, returning the same output as `str.length + len`.
 *
 * @param str - input string
 * @param search - search string

package/lib/index.js

@@ -43,9 +43,9 @@
 
 // MODULES //
 
-var endsWith = require( './ends_with.js' );
+var main = require( './main.js' );
 
 
 // EXPORTS //
 
-module.exports = endsWith;
+module.exports = main;

package/lib/{ends_with.js → main.js}

@@ -22,6 +22,8 @@
 
 var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;
 var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
+var format = require( '@stdlib/string-format' );
+var base = require( '@stdlib/string-base-ends-with' );
 
 
 // MAIN //
@@ -32,8 +34,8 @@ var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 * @param {string} str - input string
 * @param {string} search - search string
 * @param {integer} [len=str.length] - substring length
-* @throws {TypeError} first argument must be a string primitive
-* @throws {TypeError} second argument must be a string primitive
+* @throws {TypeError} first argument must be a string
+* @throws {TypeError} second argument must be a string
 * @throws {TypeError} third argument must be an integer
 * @returns {boolean} boolean indicating if the input string ends with the search string
 *
@@ -58,43 +60,20 @@ var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
 * // returns true
 */
 function endsWith( str, search, len ) {
-	var idx;
-	var i;
 	if ( !isString( str ) ) {
-		throw new TypeError( 'invalid argument. First argument must be a string primitive. Value: `' + str + '`.' );
+		throw new TypeError( format( 'invalid argument. First argument must be a string. Value: `%s`.', str ) );
 	}
 	if ( !isString( search ) ) {
-		throw new TypeError( 'invalid argument. Second argument must be a string primitive. Value: `' + search + '`.' );
+		throw new TypeError( format( 'invalid argument. Second argument must be a string. Value: `%s`.', search ) );
 	}
 	if ( arguments.length > 2 ) {
 		if ( !isInteger( len ) ) {
-			throw new TypeError( 'invalid argument. Third argument must be an integer. Value: `' + len + '`.' );
-		}
-		if ( len === 0 ) {
-			return ( search.length === 0 );
-		}
-		if ( len < 0 ) {
-			idx = str.length + len;
-		} else {
-			idx = len;
+			throw new TypeError( format( 'invalid argument. Third argument must be an integer. Value: `%s`.', len ) );
 		}
 	} else {
-		idx = str.length;
-	}
-	if ( search.length === 0 ) {
-		// Based on the premise that every string can be "surrounded" by empty strings (e.g., "" + "a" + "" + "b" + "" === "ab"):
-		return true;
-	}
-	idx -= search.length;
-	if ( idx < 0 ) {
-		return false;
-	}
-	for ( i = 0; i < search.length; i++) {
-		if ( str.charCodeAt( idx + i ) !== search.charCodeAt( i ) ) {
-			return false;
-		}
+		len = str.length;
 	}
-	return true;
+	return base( str, search, len );
 }
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-ends-with",
-  "version": "0.0.8",
+  "version": "0.1.0",
   "description": "Test if a string ends with the characters of another string.",
   "license": "Apache-2.0",
   "author": {
@@ -13,9 +13,6 @@
       "url": "https://github.com/stdlib-js/stdlib/graphs/contributors"
     }
   ],
-  "bin": {
-    "ends-with": "./bin/cli"
-  },
   "main": "./lib",
   "directories": {
     "benchmark": "./benchmark",
@@ -40,28 +37,16 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-integer": "^0.0.x",
-    "@stdlib/assert-is-regexp-string": "^0.0.x",
-    "@stdlib/assert-is-string": "^0.0.x",
-    "@stdlib/cli-ctor": "^0.0.x",
-    "@stdlib/fs-read-file": "^0.0.x",
-    "@stdlib/process-read-stdin": "^0.0.x",
-    "@stdlib/regexp-eol": "^0.0.x",
-    "@stdlib/streams-node-stdin": "^0.0.x",
-    "@stdlib/utils-regexp-from-string": "^0.0.x"
+    "@stdlib/assert-is-integer": "^0.1.0",
+    "@stdlib/assert-is-string": "^0.1.0",
+    "@stdlib/string-base-ends-with": "^0.1.0",
+    "@stdlib/string-format": "^0.1.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-boolean": "^0.0.x",
-    "@stdlib/assert-is-browser": "^0.0.x",
-    "@stdlib/assert-is-windows": "^0.0.x",
-    "@stdlib/bench": "^0.0.x",
-    "@stdlib/process-exec-path": "^0.0.x",
-    "@stdlib/string-from-code-point": "^0.0.x",
-    "@stdlib/string-replace": "^0.0.x",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",
     "istanbul": "^0.4.1",
-    "tap-spec": "5.x.x"
+    "tap-min": "git+https://github.com/Planeshifter/tap-min.git"
   },
   "engines": {
     "node": ">=0.10.0",
@@ -94,7 +79,7 @@
     "match"
   ],
   "funding": {
-    "type": "patreon",
-    "url": "https://www.patreon.com/athan"
+    "type": "opencollective",
+    "url": "https://opencollective.com/stdlib"
   }
 }

package/bin/cli

@@ -1,124 +0,0 @@
-#!/usr/bin/env node
-
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2018 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var resolve = require( 'path' ).resolve;
-var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var CLI = require( '@stdlib/cli-ctor' );
-var stdin = require( '@stdlib/process-read-stdin' );
-var stdinStream = require( '@stdlib/streams-node-stdin' );
-var RE_EOL = require( '@stdlib/regexp-eol' ).REGEXP;
-var isRegExpString = require( '@stdlib/assert-is-regexp-string' );
-var reFromString = require( '@stdlib/utils-regexp-from-string' );
-var endsWith = require( './../lib' );
-
-
-// MAIN //
-
-/**
-* Main execution sequence.
-*
-* @private
-* @returns {void}
-*/
-function main() {
-	var split;
-	var flags;
-	var args;
-	var cli;
-	var len;
-	var str;
-
-	// Create a command-line interface:
-	cli = new CLI({
-		'pkg': require( './../package.json' ),
-		'options': require( './../etc/cli_opts.json' ),
-		'help': readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-			'encoding': 'utf8'
-		})
-	});
-
-	// Get any provided command-line options:
-	flags = cli.flags();
-	if ( flags.help || flags.version ) {
-		return;
-	}
-
-	// Get any provided command-line arguments:
-	args = cli.args();
-
-	if ( args.length ) {
-		str = args[ 0 ];
-	} else {
-		// Treat an empty value as an empty string:
-		str = '';
-	}
-	if ( flags.len ) {
-		len = parseInt( flags.len, 10 );
-	} else {
-		len = str.length;
-	}
-	// Check if we are receiving data from `stdin`...
-	if ( !stdinStream.isTTY ) {
-		if ( flags.split ) {
-			if ( !isRegExpString( flags.split ) ) {
-				flags.split = '/'+flags.split+'/';
-			}
-			split = reFromString( flags.split );
-		} else {
-			split = RE_EOL;
-		}
-		return stdin( onRead );
-	}
-	console.log( endsWith( str, flags.search, len ) ); // eslint-disable-line no-console
-
-	/**
-	* Callback invoked upon reading from `stdin`.
-	*
-	* @private
-	* @param {(Error|null)} error - error object
-	* @param {Buffer} data - data
-	* @returns {void}
-	*/
-	function onRead( error, data ) {
-		var lines;
-		var i;
-		if ( error ) {
-			return cli.error( error );
-		}
-		lines = data.toString().split( split );
-
-		// Remove any trailing separators (e.g., trailing newline)...
-		if ( lines[ lines.length-1 ] === '' ) {
-			lines.pop();
-		}
-		for ( i = 0; i < lines.length; i++ ) {
-			if ( !len ) {
-				len = lines[ i ].length;
-			}
-			console.log( endsWith( lines[ i ], flags.search, len ) ); // eslint-disable-line no-console
-		}
-	}
-}
-
-main();

package/docs/repl.txt

@@ -1,42 +0,0 @@
-
-{{alias}}( str, search[, len] )
-    Tests if a `string` ends with the characters of another `string`.
-
-    If provided an empty `search` string, the function always returns `true`.
-
-    Parameters
-    ----------
-    str: string
-        Input string.
-
-    search: string
-        Search string.
-
-    len: integer (optional)
-        Substring length. Restricts the search to a substring within the input
-        string beginning from the leftmost character. If provided a negative
-        value, `len` indicates to ignore the last `len` characters, returning
-        the same output as `str.length + len`. Default: `str.length`.
-
-    Returns
-    -------
-    bool: boolean
-        Boolean indicating whether a `string` ends with the characters of
-        another `string`.
-
-    Examples
-    --------
-    > var bool = {{alias}}( 'beep', 'ep' )
-    true
-    > bool = {{alias}}( 'Beep', 'op' )
-    false
-    > bool = {{alias}}( 'Beep', 'ee', 3 )
-    true
-    > bool = {{alias}}( 'Beep', 'ee', -1 )
-    true
-    > bool = {{alias}}( 'beep', '' )
-    true
-
-    See Also
-    --------
-

package/docs/types/test.ts

@@ -1,59 +0,0 @@
-/*
-* @license Apache-2.0
-*
-* Copyright (c) 2019 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-import endsWith = require( './index' );
-
-
-// TESTS //
-
-// The function returns a boolean...
-{
-	endsWith( 'abd', 'd' ); // $ExpectType boolean
-	endsWith( 'To be, or not to be, that is the question.', 'b', 19 ); // $ExpectType boolean
-	endsWith( 'abd', 'ab', 2 ); // $ExpectType boolean
-}
-
-// The function does not compile if provided arguments having invalid types...
-{
-	endsWith( true, 'd' ); // $ExpectError
-	endsWith( false, 'd' ); // $ExpectError
-	endsWith( 3, 'd', 3 ); // $ExpectError
-	endsWith( [], 'd', 3 ); // $ExpectError
-	endsWith( {}, 'd', 3 ); // $ExpectError
-	endsWith( ( x: number ): number => x, 'd', 0 ); // $ExpectError
-
-	endsWith( 'abd', true ); // $ExpectError
-	endsWith( 'abd', false ); // $ExpectError
-	endsWith( 'abd', 5 ); // $ExpectError
-	endsWith( 'abd', [], 3 ); // $ExpectError
-	endsWith( 'abd', {}, 3 ); // $ExpectError
-	endsWith( 'abd', ( x: number ): number => x, 0 ); // $ExpectError
-
-	endsWith( 'abd', 'a', true ); // $ExpectError
-	endsWith( 'abd', 'a', false ); // $ExpectError
-	endsWith( 'abd', 'a', '5' ); // $ExpectError
-	endsWith( 'abd', 'b', [] ); // $ExpectError
-	endsWith( 'abd', 'b', {} ); // $ExpectError
-	endsWith( 'abd', 'b', /[a-z]/ ); // $ExpectError
-}
-
-// The function does not compile if provided insufficient arguments...
-{
-	endsWith(); // $ExpectError
-	endsWith( 'abc' ); // $ExpectError
-}

package/docs/usage.txt

@@ -1,10 +0,0 @@
-
-Usage: ends-with [options] --search=<string> [<string>]
-
-Options:
-
-  -h,    --help                Print this message.
-  -V,    --version             Print the package version.
-         --search string       Search string.
-         --len int             Substring length.
-         --split sep           Delimiter for stdin data. Default: '/\\r?\\n/'.

package/etc/cli_opts.json

@@ -1,19 +0,0 @@
-{
-	"boolean": [
-		"help",
-		"version"
-	],
-	"string": [
-		"search",
-		"len",
-		"split"
-	],
-	"alias": {
-		"help": [
-			"h"
-		],
-		"version": [
-			"V"
-		]
-	}
-}