@stdlib/assert-contains 0.0.7 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE CHANGED
@@ -175,307 +175,3 @@
175
175
  of your accepting any such warranty or additional liability.
176
176
 
177
177
  END OF TERMS AND CONDITIONS
178
-
179
-
180
-
181
- Boost Software License - Version 1.0 - August 17th, 2003
182
-
183
- Permission is hereby granted, free of charge, to any person or organization
184
- obtaining a copy of the software and accompanying documentation covered by this
185
- license (the "Software") to use, reproduce, display, distribute, execute, and
186
- transmit the Software, and to prepare derivative works of the Software, and to
187
- permit third-parties to whom the Software is furnished to do so, all subject to
188
- the following:
189
-
190
- The copyright notices in the Software and this entire statement, including the
191
- above license grant, this restriction and the following disclaimer, must be
192
- included in all copies of the Software, in whole or in part, and all derivative
193
- works of the Software, unless such copies or derivative works are solely in the
194
- form of machine-executable object code generated by a source language processor.
195
-
196
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
197
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
198
- FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
199
- COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE FOR ANY DAMAGES
200
- OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
201
- OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
202
-
203
-
204
-
205
-
206
- DEPENDENCIES
207
-
208
- The library links against the following external libraries, which have their own
209
- licenses:
210
-
211
- * OpenBLAS <https://raw.githubusercontent.com/xianyi/OpenBLAS/
212
- def146efed8d5908ea04e22668feeab7099599a0/LICENSE>
213
-
214
- Copyright (c) 2011-2014, The OpenBLAS Project
215
- All rights reserved.
216
-
217
- Redistribution and use in source and binary forms, with or without
218
- modification, are permitted provided that the following conditions are
219
- met:
220
-
221
- 1. Redistributions of source code must retain the above copyright
222
- notice, this list of conditions and the following disclaimer.
223
-
224
- 2. Redistributions in binary form must reproduce the above copyright
225
- notice, this list of conditions and the following disclaimer in
226
- the documentation and/or other materials provided with the
227
- distribution.
228
-
229
- 3. Neither the name of the OpenBLAS project nor the names of
230
- its contributors may be used to endorse or promote products
231
- derived from this software without specific prior written
232
- permission.
233
-
234
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
235
- AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
236
- IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
237
- ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
238
- LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
239
- CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
240
- GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
241
- HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
242
- LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
243
- THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
244
-
245
-
246
- * Electron <https://raw.githubusercontent.com/electron/electron/
247
- c4cfb3e7110266b9d7ad80e1ae097c4db564501c/LICENSE>
248
-
249
- Copyright (c) 2013-2017 GitHub Inc.
250
-
251
- Permission is hereby granted, free of charge, to any person obtaining
252
- a copy of this software and associated documentation files (the
253
- "Software"), to deal in the Software without restriction, including
254
- without limitation the rights to use, copy, modify, merge, publish,
255
- distribute, sublicense, and/or sell copies of the Software, and to
256
- permit persons to whom the Software is furnished to do so, subject to
257
- the following conditions:
258
-
259
- The above copyright notice and this permission notice shall be
260
- included in all copies or substantial portions of the Software.
261
-
262
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
263
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
264
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
265
- NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
266
- LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
267
- OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
268
- WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
269
-
270
-
271
- * Boost <http://www.boost.org/LICENSE_1_0.txt>
272
-
273
- Boost Software License - Version 1.0 - August 17th, 2003
274
-
275
- Permission is hereby granted, free of charge, to any person or organization
276
- obtaining a copy of the software and accompanying documentation covered by
277
- this license (the "Software") to use, reproduce, display, distribute,
278
- execute, and transmit the Software, and to prepare derivative works of the
279
- Software, and to permit third-parties to whom the Software is furnished to
280
- do so, all subject to the following:
281
-
282
- The copyright notices in the Software and this entire statement, including
283
- the above license grant, this restriction and the following disclaimer,
284
- must be included in all copies of the Software, in whole or in part, and
285
- all derivative works of the Software, unless such copies or derivative
286
- works are solely in the form of machine-executable object code generated by
287
- a source language processor.
288
-
289
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
290
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
291
- FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
292
- SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
293
- FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
294
- ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
295
- DEALINGS IN THE SOFTWARE.
296
-
297
-
298
- * Cephes <http://www.netlib.org/cephes/readme>
299
-
300
- Copyright (c) 1984-2000 Stephen L. Moshier
301
-
302
- Some software in this archive may be from the book _Methods and Programs for
303
- Mathematical Functions_ (Prentice-Hall or Simon & Schuster International, 1989)
304
- or from the Cephes Mathematical Library, a commercial product. In either event,
305
- it is copyrighted by the author. What you see here may be used freely but it
306
- comes with no support or guarantee.
307
-
308
- Stephen L. Moshier
309
- moshier@na-net.ornl.gov
310
-
311
-
312
-
313
- ATTRIBUTION
314
-
315
- The library contains implementations from the following external libraries,
316
- which have their own licenses:
317
-
318
- * FreeBSD <https://svnweb.freebsd.org/>
319
-
320
- Copyright (C) 1993-2004 by Sun Microsystems, Inc. All rights reserved.
321
-
322
- Developed at SunPro, a Sun Microsystems, Inc. business.
323
- Permission to use, copy, modify, and distribute this
324
- software is freely granted, provided that this notice
325
- is preserved.
326
-
327
-
328
- * FDLIBM <http://www.netlib.org/fdlibm/>
329
-
330
- Copyright (C) 2004 by Sun Microsystems, Inc. All rights reserved.
331
-
332
- Developed at SunPro, a Sun Microsystems, Inc. business.
333
- Permission to use, copy, modify, and distribute this
334
- software is freely granted, provided that this notice
335
- is preserved.
336
-
337
-
338
- * Go <https://raw.githubusercontent.com/golang/go/master/LICENSE>
339
-
340
- Copyright (c) 2009 The Go Authors. All rights reserved.
341
-
342
- Redistribution and use in source and binary forms, with or without
343
- modification, are permitted provided that the following conditions are
344
- met:
345
-
346
- * Redistributions of source code must retain the above copyright
347
- notice, this list of conditions and the following disclaimer.
348
- * Redistributions in binary form must reproduce the above
349
- copyright notice, this list of conditions and the following disclaimer
350
- in the documentation and/or other materials provided with the
351
- distribution.
352
- * Neither the name of Google Inc. nor the names of its
353
- contributors may be used to endorse or promote products derived from
354
- this software without specific prior written permission.
355
-
356
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
357
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
358
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
359
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
360
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
361
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
362
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
363
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
364
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
365
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
366
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
367
-
368
-
369
- * SLATEC Common Mathematical Library <http://www.netlib.no/netlib/slatec/>
370
-
371
- Public domain.
372
-
373
-
374
- * ESLint <https://raw.githubusercontent.com/eslint/eslint/master/LICENSE>
375
-
376
- Copyright JS Foundation and other contributors, https://js.foundation
377
-
378
- Permission is hereby granted, free of charge, to any person obtaining a copy
379
- of this software and associated documentation files (the "Software"), to deal
380
- in the Software without restriction, including without limitation the rights
381
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
382
- copies of the Software, and to permit persons to whom the Software is
383
- furnished to do so, subject to the following conditions:
384
-
385
- The above copyright notice and this permission notice shall be included in
386
- all copies or substantial portions of the Software.
387
-
388
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
389
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
390
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
391
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
392
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
393
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
394
- THE SOFTWARE.
395
-
396
-
397
- * StatsFuns.jl <https://raw.githubusercontent.com/JuliaStats/StatsFuns.jl/
398
- e66dd973650c375bc1739c820e5b96bb5bd000a8/LICENSE.md>
399
-
400
- Copyright (c) 2015: Dahua Lin.
401
-
402
- Permission is hereby granted, free of charge, to any person obtaining
403
- a copy of this software and associated documentation files (the
404
- "Software"), to deal in the Software without restriction, including
405
- without limitation the rights to use, copy, modify, merge, publish,
406
- distribute, sublicense, and/or sell copies of the Software, and to
407
- permit persons to whom the Software is furnished to do so, subject to
408
- the following conditions:
409
-
410
- The above copyright notice and this permission notice shall be
411
- included in all copies or substantial portions of the Software.
412
-
413
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
414
- EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
415
- MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
416
- IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
417
- CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
418
- TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
419
- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
420
-
421
-
422
- * SpecialFunctions.jl <https://raw.githubusercontent.com/JuliaMath/
423
- SpecialFunctions.jl/02a173fbe24a61c4b392aec17a9764ac5727feb1/LICENSE>
424
-
425
- The MIT License (MIT)
426
-
427
- Copyright (c) 2017 Jeff Bezanson, Stefan Karpinski, Viral B. Shah, and others:
428
-
429
- https://github.com/JuliaMath/SpecialFunctions.jl/graphs/contributors
430
-
431
- Permission is hereby granted, free of charge, to any person obtaining a copy
432
- of this software and associated documentation files (the "Software"), to deal
433
- in the Software without restriction, including without limitation the rights
434
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
435
- copies of the Software, and to permit persons to whom the Software is
436
- furnished to do so, subject to the following conditions:
437
-
438
- The above copyright notice and this permission notice shall be included in all
439
- copies or substantial portions of the Software.
440
-
441
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
442
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
443
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
444
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
445
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
446
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
447
- SOFTWARE.
448
-
449
-
450
- * MT19937 <http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/MT2002/CODES/
451
- mt19937ar.c>
452
-
453
- Copyright (C) 1997 - 2002, Makoto Matsumoto and Takuji Nishimura,
454
- All rights reserved.
455
-
456
- Redistribution and use in source and binary forms, with or without
457
- modification, are permitted provided that the following conditions
458
- are met:
459
-
460
- 1. Redistributions of source code must retain the above copyright
461
- notice, this list of conditions and the following disclaimer.
462
-
463
- 2. Redistributions in binary form must reproduce the above copyright
464
- notice, this list of conditions and the following disclaimer in the
465
- documentation and/or other materials provided with the distribution.
466
-
467
- 3. The names of its contributors may not be used to endorse or promote
468
- products derived from this software without specific prior written
469
- permission.
470
-
471
- THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
472
- "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
473
- LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
474
- A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
475
- OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
476
- SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
477
- LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
478
- DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
479
- THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
480
- (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
481
- OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
package/NOTICE CHANGED
@@ -1 +1 @@
1
- Copyright (c) 2016-2022 The Stdlib Authors.
1
+ Copyright (c) 2016-2024 The Stdlib Authors.
package/README.md CHANGED
@@ -18,6 +18,17 @@ limitations under the License.
18
18
 
19
19
  -->
20
20
 
21
+
22
+ <details>
23
+ <summary>
24
+ About stdlib...
25
+ </summary>
26
+ <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>
27
+ <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>
28
+ <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>
29
+ <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>
30
+ </details>
31
+
21
32
  # Contains
22
33
 
23
34
  [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -191,7 +202,7 @@ See [LICENSE][stdlib-license].
191
202
 
192
203
  ## Copyright
193
204
 
194
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
205
+ Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
195
206
 
196
207
  </section>
197
208
 
@@ -204,8 +215,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
204
215
  [npm-image]: http://img.shields.io/npm/v/@stdlib/assert-contains.svg
205
216
  [npm-url]: https://npmjs.org/package/@stdlib/assert-contains
206
217
 
207
- [test-image]: https://github.com/stdlib-js/assert-contains/actions/workflows/test.yml/badge.svg
208
- [test-url]: https://github.com/stdlib-js/assert-contains/actions/workflows/test.yml
218
+ [test-image]: https://github.com/stdlib-js/assert-contains/actions/workflows/test.yml/badge.svg?branch=v0.2.0
219
+ [test-url]: https://github.com/stdlib-js/assert-contains/actions/workflows/test.yml?query=branch:v0.2.0
209
220
 
210
221
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-contains/main.svg
211
222
  [coverage-url]: https://codecov.io/github/stdlib-js/assert-contains?branch=main
@@ -217,19 +228,23 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
217
228
 
218
229
  -->
219
230
 
231
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
232
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
233
+
234
+ [stdlib]: https://github.com/stdlib-js/stdlib
235
+
236
+ [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
237
+
220
238
  [umd]: https://github.com/umdjs/umd
221
239
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
222
240
 
223
241
  [deno-url]: https://github.com/stdlib-js/assert-contains/tree/deno
242
+ [deno-readme]: https://github.com/stdlib-js/assert-contains/blob/deno/README.md
224
243
  [umd-url]: https://github.com/stdlib-js/assert-contains/tree/umd
244
+ [umd-readme]: https://github.com/stdlib-js/assert-contains/blob/umd/README.md
225
245
  [esm-url]: https://github.com/stdlib-js/assert-contains/tree/esm
226
-
227
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
228
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
229
-
230
- [stdlib]: https://github.com/stdlib-js/stdlib
231
-
232
- [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
246
+ [esm-readme]: https://github.com/stdlib-js/assert-contains/blob/esm/README.md
247
+ [branches-url]: https://github.com/stdlib-js/assert-contains/blob/main/branches.md
233
248
 
234
249
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-contains/main/LICENSE
235
250
 
package/SECURITY.md ADDED
@@ -0,0 +1,5 @@
1
+ # Security
2
+
3
+ > Policy for reporting security vulnerabilities.
4
+
5
+ See the security policy [in the main project repository](https://github.com/stdlib-js/stdlib/security).
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import contains from '../docs/types/index';
3
+ export = contains;
package/dist/index.js ADDED
@@ -0,0 +1,5 @@
1
+ "use strict";var o=function(r,e){return function(){return e||r((e={exports:{}}).exports,e),e.exports}};var g=o(function(h,m){
2
+ var v=require('@stdlib/assert-is-collection/dist'),w=require('@stdlib/assert-is-integer/dist').isPrimitive,s=require('@stdlib/assert-is-string/dist').isPrimitive,f=require('@stdlib/assert-is-nan/dist').isPrimitive,a=require('@stdlib/error-tools-fmtprodmsg/dist');function d(r,e,n){var u,t,i;if(!v(r)&&!s(r))throw new TypeError(a('02b38',r));if(arguments.length<2)throw new Error(a('02b0A'));if(arguments.length>2){if(!w(n))throw new TypeError(a('02b2z',n));t=n,t<0&&(t=0)}else t=0;if(s(r)){if(!s(e))throw new TypeError(a('02b39',e));return r.indexOf(e,t)!==-1}if(u=r.length,f(e)){for(i=t;i<u;i++)if(f(r[i]))return!0;return!1}for(i=t;i<u;i++)if(r[i]===e)return!0;return!1}m.exports=d
3
+ });var l=g();module.exports=l;
4
+ /** @license Apache-2.0 */
5
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../lib/main.js", "../lib/index.js"],
4
+ "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 isCollection = require( '@stdlib/assert-is-collection' );\nvar isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isnan = require( '@stdlib/assert-is-nan' ).isPrimitive;\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Tests if an array-like value contains a search value.\n*\n* @param {(Collection|string)} val - input value\n* @param {*} searchValue - search value\n* @param {integer} [position=0] - position at which to start searching for `searchValue`\n* @throws {TypeError} first argument must be array-like\n* @throws {Error} must provide a search value\n* @throws {TypeError} second argument must be a string when the first argument is a string\n* @throws {TypeError} third argument must be an integer\n* @returns {boolean} boolean indicating whether one value contains another\n*\n* @example\n* var bool = contains( 'last man standing', 'stand' );\n* // returns true\n*\n* @example\n* var bool = contains( [ 1, 2, 3, 4 ], 2 );\n* // returns true\n*\n* @example\n* var bool = contains( 'presidential election', 'president' );\n* // returns true\n*\n* @example\n* var bool = contains( [ NaN, 2, 3, 4 ], NaN );\n* // returns true\n*\n* @example\n* var bool = contains( 'javaScript', 'js' );\n* // returns false\n*\n* @example\n* var bool = contains( [ 1, 2, 3, {} ], {} );\n* // returns false\n*\n* @example\n* var bool = contains( 'Hidden Treasures', '' );\n* // returns true\n*/\nfunction contains( val, searchValue, position ) {\n\tvar len;\n\tvar pos;\n\tvar i;\n\tif ( !isCollection( val ) && !isString( val ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. First argument must be array-like. Value: `%s`.', val ) );\n\t}\n\tif ( arguments.length < 2 ) {\n\t\tthrow new Error( 'insufficient arguments. Must provide a search value.' );\n\t}\n\tif ( arguments.length > 2 ) {\n\t\tif ( !isInteger( position ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Third argument must be an integer. Value: `%s`.', position ) );\n\t\t}\n\t\tpos = position;\n\t\tif ( pos < 0 ) {\n\t\t\tpos = 0;\n\t\t}\n\t} else {\n\t\tpos = 0;\n\t}\n\tif ( isString( val ) ) {\n\t\tif ( !isString( searchValue ) ) {\n\t\t\tthrow new TypeError( format( 'invalid argument. Second argument must be a string. Value: `%s`.', searchValue ) );\n\t\t}\n\t\treturn val.indexOf( searchValue, pos ) !== -1;\n\t}\n\tlen = val.length;\n\tif ( isnan( searchValue ) ) {\n\t\tfor ( i = pos; i < len; i++ ) {\n\t\t\tif ( isnan( val[ i ] ) ) {\n\t\t\t\treturn true;\n\t\t\t}\n\t\t}\n\t\treturn false;\n\t}\n\tfor ( i = pos; i < len; i++ ) {\n\t\tif ( val[ i ] === searchValue ) {\n\t\t\treturn true;\n\t\t}\n\t}\n\treturn false;\n}\n\n\n// EXPORTS //\n\nmodule.exports = contains;\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 an array-like value contains another value.\n*\n* @module @stdlib/assert-contains\n*\n* @example\n* var contains = require( '@stdlib/assert-contains' );\n*\n* var bool = contains( 'Hello World', 'World' );\n* // returns true\n*\n* bool = contains( 'Hello World', 'world' );\n* // returns false\n*\n* bool = contains( [ 1, 2, 3, 4 ], 2 );\n* // returns true\n*\n* bool = contains( [ NaN, 2, 3, 4 ], NaN );\n* // returns true\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAe,QAAS,8BAA+B,EACvDC,EAAY,QAAS,2BAA4B,EAAE,YACnDC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAQ,QAAS,uBAAwB,EAAE,YAC3CC,EAAS,QAAS,uBAAwB,EA6C9C,SAASC,EAAUC,EAAKC,EAAaC,EAAW,CAC/C,IAAIC,EACAC,EACA,EACJ,GAAK,CAACV,EAAcM,CAAI,GAAK,CAACJ,EAAUI,CAAI,EAC3C,MAAM,IAAI,UAAWF,EAAQ,oEAAqEE,CAAI,CAAE,EAEzG,GAAK,UAAU,OAAS,EACvB,MAAM,IAAI,MAAO,sDAAuD,EAEzE,GAAK,UAAU,OAAS,EAAI,CAC3B,GAAK,CAACL,EAAWO,CAAS,EACzB,MAAM,IAAI,UAAWJ,EAAQ,oEAAqEI,CAAS,CAAE,EAE9GE,EAAMF,EACDE,EAAM,IACVA,EAAM,EAER,MACCA,EAAM,EAEP,GAAKR,EAAUI,CAAI,EAAI,CACtB,GAAK,CAACJ,EAAUK,CAAY,EAC3B,MAAM,IAAI,UAAWH,EAAQ,mEAAoEG,CAAY,CAAE,EAEhH,OAAOD,EAAI,QAASC,EAAaG,CAAI,IAAM,EAC5C,CAEA,GADAD,EAAMH,EAAI,OACLH,EAAOI,CAAY,EAAI,CAC3B,IAAM,EAAIG,EAAK,EAAID,EAAK,IACvB,GAAKN,EAAOG,EAAK,CAAE,CAAE,EACpB,MAAO,GAGT,MAAO,EACR,CACA,IAAM,EAAII,EAAK,EAAID,EAAK,IACvB,GAAKH,EAAK,CAAE,IAAMC,EACjB,MAAO,GAGT,MAAO,EACR,CAKAR,EAAO,QAAUM,IC3EjB,IAAIM,EAAO,IAKX,OAAO,QAAUA",
6
+ "names": ["require_main", "__commonJSMin", "exports", "module", "isCollection", "isInteger", "isString", "isnan", "format", "contains", "val", "searchValue", "position", "len", "pos", "main"]
7
+ }
@@ -16,7 +16,7 @@
16
16
  * limitations under the License.
17
17
  */
18
18
 
19
- // TypeScript Version: 2.0
19
+ // TypeScript Version: 4.1
20
20
 
21
21
  /// <reference types="@stdlib/types"/>
22
22
 
@@ -67,7 +67,7 @@ import { ArrayLike } from '@stdlib/types/array';
67
67
  * var bool = contains( 'Hidden Treasures', '' );
68
68
  * // returns true
69
69
  */
70
- declare function contains( val: ArrayLike<any>, searchValue: any, position?: number ): boolean; // tslint:disable-line:max-line-length
70
+ declare function contains( val: ArrayLike<any>, searchValue: any, position?: number ): boolean;
71
71
 
72
72
 
73
73
  // EXPORTS //
package/lib/index.js CHANGED
@@ -41,9 +41,9 @@
41
41
 
42
42
  // MODULES //
43
43
 
44
- var contains = require( './contains.js' );
44
+ var main = require( './main.js' );
45
45
 
46
46
 
47
47
  // EXPORTS //
48
48
 
49
- module.exports = contains;
49
+ module.exports = main;
@@ -24,6 +24,7 @@ var isCollection = require( '@stdlib/assert-is-collection' );
24
24
  var isInteger = require( '@stdlib/assert-is-integer' ).isPrimitive;
25
25
  var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
26
26
  var isnan = require( '@stdlib/assert-is-nan' ).isPrimitive;
27
+ var format = require( '@stdlib/string-format' );
27
28
 
28
29
 
29
30
  // MAIN //
@@ -36,7 +37,7 @@ var isnan = require( '@stdlib/assert-is-nan' ).isPrimitive;
36
37
  * @param {integer} [position=0] - position at which to start searching for `searchValue`
37
38
  * @throws {TypeError} first argument must be array-like
38
39
  * @throws {Error} must provide a search value
39
- * @throws {TypeError} second argument must be a primitive string primitive when the first argument is a string
40
+ * @throws {TypeError} second argument must be a string when the first argument is a string
40
41
  * @throws {TypeError} third argument must be an integer
41
42
  * @returns {boolean} boolean indicating whether one value contains another
42
43
  *
@@ -73,14 +74,14 @@ function contains( val, searchValue, position ) {
73
74
  var pos;
74
75
  var i;
75
76
  if ( !isCollection( val ) && !isString( val ) ) {
76
- throw new TypeError( 'invalid argument. First argument must be array-like. Value: `' + val + '`.' );
77
+ throw new TypeError( format( 'invalid argument. First argument must be array-like. Value: `%s`.', val ) );
77
78
  }
78
79
  if ( arguments.length < 2 ) {
79
- throw new Error( 'insufficient input arguments. Must provide a search value.' );
80
+ throw new Error( 'insufficient arguments. Must provide a search value.' );
80
81
  }
81
82
  if ( arguments.length > 2 ) {
82
83
  if ( !isInteger( position ) ) {
83
- throw new TypeError( 'invalid argument. Third argument must be an integer. Value: `' + position + '`.' );
84
+ throw new TypeError( format( 'invalid argument. Third argument must be an integer. Value: `%s`.', position ) );
84
85
  }
85
86
  pos = position;
86
87
  if ( pos < 0 ) {
@@ -91,7 +92,7 @@ function contains( val, searchValue, position ) {
91
92
  }
92
93
  if ( isString( val ) ) {
93
94
  if ( !isString( searchValue ) ) {
94
- throw new TypeError( 'invalid argument. Second argument must be a string primitive. Value: `' + searchValue + '`.' );
95
+ throw new TypeError( format( 'invalid argument. Second argument must be a string. Value: `%s`.', searchValue ) );
95
96
  }
96
97
  return val.indexOf( searchValue, pos ) !== -1;
97
98
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/assert-contains",
3
- "version": "0.0.7",
3
+ "version": "0.2.0",
4
4
  "description": "Test if an array-like value contains a search value.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,21 +37,24 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/assert-is-collection": "^0.0.x",
41
- "@stdlib/assert-is-integer": "^0.0.x",
42
- "@stdlib/assert-is-nan": "^0.0.x",
43
- "@stdlib/assert-is-string": "^0.0.x",
44
- "@stdlib/types": "^0.0.x"
40
+ "@stdlib/assert-is-collection": "^0.2.0",
41
+ "@stdlib/assert-is-integer": "^0.2.0",
42
+ "@stdlib/assert-is-nan": "^0.2.0",
43
+ "@stdlib/assert-is-string": "^0.2.0",
44
+ "@stdlib/string-format": "^0.2.0",
45
+ "@stdlib/types": "^0.3.1",
46
+ "@stdlib/error-tools-fmtprodmsg": "^0.1.1"
45
47
  },
46
48
  "devDependencies": {
47
- "@stdlib/assert-is-boolean": "^0.0.x",
48
- "@stdlib/bench": "^0.0.x",
49
- "@stdlib/math-base-special-pow": "^0.0.x",
50
- "@stdlib/random-base-randu": "^0.0.x",
51
- "@stdlib/string-from-code-point": "^0.0.x",
49
+ "@stdlib/assert-is-boolean": "^0.1.1",
50
+ "@stdlib/math-base-special-pow": "^0.1.0",
51
+ "@stdlib/random-base-randu": "^0.1.0",
52
+ "@stdlib/string-from-code-point": "^0.1.0",
52
53
  "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
53
54
  "istanbul": "^0.4.1",
54
- "tap-spec": "5.x.x"
55
+ "tap-min": "git+https://github.com/Planeshifter/tap-min.git",
56
+ "@stdlib/bench-harness": "^0.1.2",
57
+ "@stdlib/bench": "^0.3.1"
55
58
  },
56
59
  "engines": {
57
60
  "node": ">=0.10.0",
@@ -88,7 +91,7 @@
88
91
  "includes"
89
92
  ],
90
93
  "funding": {
91
- "type": "patreon",
92
- "url": "https://www.patreon.com/athan"
94
+ "type": "opencollective",
95
+ "url": "https://opencollective.com/stdlib"
93
96
  }
94
97
  }
package/docs/repl.txt DELETED
@@ -1,57 +0,0 @@
1
-
2
- {{alias}}( val, searchValue[, position] )
3
- Tests if an array-like value contains a search value.
4
-
5
- When `val` is a string, the function checks whether the characters of the
6
- search string are found in the input string. The search is case-sensitive.
7
-
8
- When `val` is an array-like object, the function checks whether the input
9
- array contains an element strictly equal to the specified search value.
10
-
11
- For strings, this function is modeled after `String.prototype.includes`,
12
- part of the ECMAScript 6 specification. This function is different from a
13
- call to `String.prototype.includes.call` insofar as type-checking is
14
- performed for all arguments.
15
-
16
- The function does not distinguish between positive and negative zero.
17
-
18
- If `position < 0`, the search is performed for the entire input array or
19
- string.
20
-
21
-
22
- Parameters
23
- ----------
24
- val: ArrayLike
25
- Input value.
26
-
27
- searchValue: any
28
- Value to search for.
29
-
30
- position: integer (optional)
31
- Position at which to start searching for `searchValue`. Default: `0`.
32
-
33
- Returns
34
- -------
35
- bool: boolean
36
- Boolean indicating if an input value contains another value.
37
-
38
- Examples
39
- --------
40
- > var bool = {{alias}}( 'Hello World', 'World' )
41
- true
42
- > bool = {{alias}}( 'Hello World', 'world' )
43
- false
44
- > bool = {{alias}}( [ 1, 2, 3, 4 ], 2 )
45
- true
46
- > bool = {{alias}}( [ NaN, 2, 3, 4 ], NaN )
47
- true
48
-
49
- // Supply a position:
50
- > bool = {{alias}}( 'Hello World', 'Hello', 6 )
51
- false
52
- > bool = {{alias}}( [ true, NaN, false ], true, 1 )
53
- false
54
-
55
- See Also
56
- --------
57
-
@@ -1,51 +0,0 @@
1
- /*
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2019 The Stdlib Authors.
5
- *
6
- * Licensed under the Apache License, Version 2.0 (the "License");
7
- * you may not use this file except in compliance with the License.
8
- * You may obtain a copy of the License at
9
- *
10
- * http://www.apache.org/licenses/LICENSE-2.0
11
- *
12
- * Unless required by applicable law or agreed to in writing, software
13
- * distributed under the License is distributed on an "AS IS" BASIS,
14
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15
- * See the License for the specific language governing permissions and
16
- * limitations under the License.
17
- */
18
-
19
- import contains = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a boolean...
25
- {
26
- contains( 'abd', 'a' ); // $ExpectType boolean
27
- contains( 'To be, or not to be, that is the question.', 'question', 10 ); // $ExpectType boolean
28
- contains( 'abd', 'ab', 2 ); // $ExpectType boolean
29
- contains( [ 1, 2, 3, 4, 5, 6 ], 2 ); // $ExpectType boolean
30
- contains( [ 1, 2, 3, 4, 5, 6 ], 2, 3 ); // $ExpectType boolean
31
- }
32
-
33
- // The function does not compile if provided arguments having invalid types...
34
- {
35
- contains( true, 'd' ); // $ExpectError
36
- contains( false, 'd' ); // $ExpectError
37
- contains( 3, 'd', 3 ); // $ExpectError
38
- contains( {}, 'd', 3 ); // $ExpectError
39
-
40
- contains( 'abd', 'a', true ); // $ExpectError
41
- contains( 'abd', 'a', false ); // $ExpectError
42
- contains( 'abd', 'a', [] ); // $ExpectError
43
- contains( 'abd', 'a', {} ); // $ExpectError
44
- contains( 'abd', 'a', ( x: number ): number => x ); // $ExpectError
45
- }
46
-
47
- // The function does not compile if provided insufficient arguments...
48
- {
49
- contains(); // $ExpectError
50
- contains( 'abc' ); // $ExpectError
51
- }