@stdlib/assert-deep-has-own-property 0.0.6 → 0.1.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/CITATION.cff ADDED
@@ -0,0 +1,30 @@
1
+ cff-version: 1.2.0
2
+ title: stdlib
3
+ message: >-
4
+ If you use this software, please cite it using the
5
+ metadata from this file.
6
+
7
+ type: software
8
+
9
+ authors:
10
+ - name: The Stdlib Authors
11
+ url: https://github.com/stdlib-js/stdlib/graphs/contributors
12
+
13
+ repository-code: https://github.com/stdlib-js/stdlib
14
+ url: https://stdlib.io
15
+
16
+ abstract: |
17
+ Standard library for JavaScript and Node.js.
18
+
19
+ keywords:
20
+ - JavaScript
21
+ - Node.js
22
+ - TypeScript
23
+ - standard library
24
+ - scientific computing
25
+ - numerical computing
26
+ - statistical computing
27
+
28
+ license: Apache-2.0 AND BSL-1.0
29
+
30
+ date-released: 2016
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-2023 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
  # deepHasOwnProp
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] -->
@@ -217,10 +228,7 @@ var bool = has( obj );
217
228
  ```javascript
218
229
  var deepHasOwnProp = require( '@stdlib/assert-deep-has-own-property' );
219
230
 
220
- var bool;
221
- var has;
222
-
223
- bool = deepHasOwnProp( { 'a': { 'b': { 'c': 'd' } } }, 'a.b.c' );
231
+ var bool = deepHasOwnProp( { 'a': { 'b': { 'c': 'd' } } }, 'a.b.c' );
224
232
  // returns true
225
233
 
226
234
  bool = deepHasOwnProp( { 'a': { 'b': { 'c': 'd' } } }, [ 'a', 'b', 'c' ] );
@@ -243,7 +251,7 @@ bool = deepHasOwnProp( { 'a': { 'b': { 'c': 'd' } } }, 'a/b/c/d/e', {
243
251
  // returns false
244
252
 
245
253
  // Create a customized function:
246
- has = deepHasOwnProp.factory( 'a_b_c', {
254
+ var has = deepHasOwnProp.factory( 'a_b_c', {
247
255
  'sep': '_'
248
256
  });
249
257
 
@@ -266,11 +274,11 @@ bool = has( { 'a': [ { 'b': { 'c': 'd' } } ] } );
266
274
 
267
275
  ## See Also
268
276
 
269
- - <span class="package-name">[`@stdlib/assert/deep-has-property`][@stdlib/assert/deep-has-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path, either own or inherited.</span>
270
- - <span class="package-name">[`@stdlib/assert/has-own-property`][@stdlib/assert/has-own-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property.</span>
271
- - <span class="package-name">[`@stdlib/utils/deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
272
- - <span class="package-name">[`@stdlib/utils/deep-pluck`][@stdlib/utils/deep-pluck]</span><span class="delimiter">: </span><span class="description">extract a nested property value from each element of an object array.</span>
273
- - <span class="package-name">[`@stdlib/utils/deep-set`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>
277
+ - <span class="package-name">[`@stdlib/assert-deep-has-property`][@stdlib/assert/deep-has-property]</span><span class="delimiter">: </span><span class="description">test whether an object contains a nested key path, either own or inherited.</span>
278
+ - <span class="package-name">[`@stdlib/assert-has-own-property`][@stdlib/assert/has-own-property]</span><span class="delimiter">: </span><span class="description">test if an object has a specified property.</span>
279
+ - <span class="package-name">[`@stdlib/utils-deep-get`][@stdlib/utils/deep-get]</span><span class="delimiter">: </span><span class="description">get a nested property value.</span>
280
+ - <span class="package-name">[`@stdlib/utils-deep-pluck`][@stdlib/utils/deep-pluck]</span><span class="delimiter">: </span><span class="description">extract a nested property value from each element of an object array.</span>
281
+ - <span class="package-name">[`@stdlib/utils-deep-set`][@stdlib/utils/deep-set]</span><span class="delimiter">: </span><span class="description">set a nested property value.</span>
274
282
 
275
283
  </section>
276
284
 
@@ -302,7 +310,7 @@ See [LICENSE][stdlib-license].
302
310
 
303
311
  ## Copyright
304
312
 
305
- Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
313
+ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
306
314
 
307
315
  </section>
308
316
 
@@ -315,8 +323,8 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
315
323
  [npm-image]: http://img.shields.io/npm/v/@stdlib/assert-deep-has-own-property.svg
316
324
  [npm-url]: https://npmjs.org/package/@stdlib/assert-deep-has-own-property
317
325
 
318
- [test-image]: https://github.com/stdlib-js/assert-deep-has-own-property/actions/workflows/test.yml/badge.svg
319
- [test-url]: https://github.com/stdlib-js/assert-deep-has-own-property/actions/workflows/test.yml
326
+ [test-image]: https://github.com/stdlib-js/assert-deep-has-own-property/actions/workflows/test.yml/badge.svg?branch=v0.1.0
327
+ [test-url]: https://github.com/stdlib-js/assert-deep-has-own-property/actions/workflows/test.yml?query=branch:v0.1.0
320
328
 
321
329
  [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-deep-has-own-property/main.svg
322
330
  [coverage-url]: https://codecov.io/github/stdlib-js/assert-deep-has-own-property?branch=main
@@ -328,19 +336,20 @@ Copyright &copy; 2016-2022. The Stdlib [Authors][stdlib-authors].
328
336
 
329
337
  -->
330
338
 
339
+ [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
340
+ [chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
341
+
342
+ [stdlib]: https://github.com/stdlib-js/stdlib
343
+
344
+ [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
345
+
331
346
  [umd]: https://github.com/umdjs/umd
332
347
  [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
333
348
 
334
349
  [deno-url]: https://github.com/stdlib-js/assert-deep-has-own-property/tree/deno
335
350
  [umd-url]: https://github.com/stdlib-js/assert-deep-has-own-property/tree/umd
336
351
  [esm-url]: https://github.com/stdlib-js/assert-deep-has-own-property/tree/esm
337
-
338
- [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
339
- [chat-url]: https://gitter.im/stdlib-js/stdlib/
340
-
341
- [stdlib]: https://github.com/stdlib-js/stdlib
342
-
343
- [stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors
352
+ [branches-url]: https://github.com/stdlib-js/assert-deep-has-own-property/blob/main/branches.md
344
353
 
345
354
  [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-deep-has-own-property/main/LICENSE
346
355
 
@@ -0,0 +1,3 @@
1
+ /// <reference path="../docs/types/index.d.ts" />
2
+ import deepHasOwnProp from '../docs/types/index';
3
+ export = deepHasOwnProp;
package/dist/index.js ADDED
@@ -0,0 +1,14 @@
1
+ "use strict";var u=function(e,r){return function(){return r||e((r={exports:{}}).exports,r),r.exports}};var v=u(function(N,q){
2
+ var P=require('@stdlib/assert-is-string/dist').isPrimitive,b=require('@stdlib/assert-is-plain-object/dist'),x=require('@stdlib/assert-has-own-property/dist'),p=require('@stdlib/error-tools-fmtprodmsg/dist');function h(e,r){return b(r)?x(r,"sep")&&(e.sep=r.sep,!P(e.sep))?new TypeError(p('02f2W',"sep",e.sep)):null:new TypeError(p('02f2V',r));}q.exports=h
3
+ });var f=u(function(Q,c){
4
+ function S(){return{sep:"."}}c.exports=S
5
+ });var l=u(function(U,m){
6
+ var E=require('@stdlib/assert-has-own-property/dist');function T(e,r){var t=r.length,i;if(t===0)return!1;for(i=0;i<t;i++)if(E(e,r[i]))e=e[r[i]];else return!1;return!0}m.exports=T
7
+ });var y=u(function(W,d){
8
+ var H=require('@stdlib/assert-is-string/dist').isPrimitive,V=require('@stdlib/assert-is-array/dist'),j=require('@stdlib/error-tools-fmtprodmsg/dist'),k=v(),A=f(),K=l();function R(e,r,t){var i,a,s,n;if(i=H(r),!i&&!V(r))throw new TypeError(j('02f3A',r));if(s=A(),arguments.length>2&&(n=k(s,t),n))throw n;return e==null?!1:(i?a=r.split(s.sep):a=r,K(e,a))}d.exports=R
9
+ });var w=u(function(X,g){
10
+ var z=require('@stdlib/assert-is-string/dist').isPrimitive,B=require('@stdlib/assert-is-array/dist'),C=require('@stdlib/error-tools-fmtprodmsg/dist'),D=v(),F=f(),G=l();function I(e,r){var t,i,a,s;if(t=z(e),!t&&!B(e))throw new TypeError(C('02f3A',e));if(a=F(),arguments.length>1&&(s=D(a,r),s))throw s;return t?i=e.split(a.sep):i=e,n;function n(o){return o==null?!1:G(o,i)}}g.exports=I
11
+ });var J=require('@stdlib/utils-define-nonenumerable-read-only-property/dist'),O=y(),L=w();J(O,"factory",L);module.exports=O;
12
+ /** @license Apache-2.0 */
13
+ /** @license Apache-2.0 */
14
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1,7 @@
1
+ {
2
+ "version": 3,
3
+ "sources": ["../lib/validate.js", "../lib/defaults.js", "../lib/has.js", "../lib/main.js", "../lib/factory.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 isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isObject = require( '@stdlib/assert-is-plain-object' );\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\nvar format = require( '@stdlib/string-format' );\n\n\n// MAIN //\n\n/**\n* Validates function options.\n*\n* @private\n* @param {Object} opts - destination for function options\n* @param {Options} options - function options\n* @param {string} [options.sep] - key path separator\n* @returns {(Error|null)} error or null\n*\n* @example\n* var opts = {};\n* var options = {\n* 'sep': '/'\n* };\n* var err = validate( opts, options );\n* if ( err ) {\n* throw err;\n* }\n*/\nfunction validate( opts, options ) {\n\tif ( !isObject( options ) ) {\n\t\treturn new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );\n\t}\n\tif ( hasOwnProp( options, 'sep' ) ) {\n\t\topts.sep = options.sep;\n\t\tif ( !isString( opts.sep ) ) {\n\t\t\treturn new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'sep', opts.sep ) );\n\t\t}\n\t}\n\treturn null;\n}\n\n\n// EXPORTS //\n\nmodule.exports = validate;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 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// MAIN //\n\n/**\n* Returns default options.\n*\n* @private\n* @returns {Object} default options\n*/\nfunction defaults() {\n\treturn {\n\t\t'sep': '.'\n\t};\n}\n\n\n// EXPORTS //\n\nmodule.exports = defaults;\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// MODULES //\n\nvar hasOwnProp = require( '@stdlib/assert-has-own-property' );\n\n\n// MAIN //\n\n/**\n* Returns a boolean indicating whether an object has a nested property.\n*\n* @private\n* @param {*} v - value to test\n* @param {Array} props - list of properties defining a key path\n* @returns {boolean} boolean indicating whether an object has a nested property\n*/\nfunction deepHasOwnProp( v, props ) {\n\tvar len = props.length;\n\tvar i;\n\tif ( len === 0 ) {\n\t\treturn false;\n\t}\n\tfor ( i = 0; i < len; i++ ) {\n\t\tif ( hasOwnProp( v, props[ i ] ) ) {\n\t\t\tv = v[ props[ i ] ];\n\t\t} else {\n\t\t\treturn false;\n\t\t}\n\t}\n\treturn true;\n}\n\n\n// EXPORTS //\n\nmodule.exports = deepHasOwnProp;\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// MODULES //\n\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isArray = require( '@stdlib/assert-is-array' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\nvar defaults = require( './defaults.js' );\nvar has = require( './has.js' );\n\n\n// MAIN //\n\n/**\n* Tests whether an object contains a nested key path.\n*\n* @param {*} value - value to test\n* @param {(string|Array)} path - key path\n* @param {Options} [options] - function options\n* @param {string} [options.sep='.'] - key path separator\n* @throws {TypeError} second argument must be a string or key array\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {boolean} boolean indicating whether an object has a nested property\n*\n* @example\n* var obj = { 'a': { 'b': { 'c': 'd' } } };\n* var bool = deepHasOwnProp( obj, 'a.b.c' );\n* // returns true\n*\n* @example\n* var arr = [\n* {\n* 'a': [\n* {\n* 'b': [\n* { 'c': 'd' },\n* { 'e': 'f' }\n* ]\n* }\n* ]\n* }\n* ];\n* var bool = deepHasOwnProp( arr, '0.a.0.b.0.c' );\n* // returns true\n*\n* @example\n* var obj = { 'a': { 'b': { 'c': 'd' } } };\n* var bool = deepHasOwnProp( obj, [ 'a', 'b', 'c' ] );\n* // returns true\n*\n* @example\n* var obj = { 'a': { 'b': { 'c': 'd' } } };\n* var bool = deepHasOwnProp( obj, 'a/b/c', {\n* 'sep': '/'\n* });\n* // returns true\n*/\nfunction deepHasOwnProp( value, path, options ) {\n\tvar isStr;\n\tvar props;\n\tvar opts;\n\tvar err;\n\n\tisStr = isString( path );\n\tif ( !isStr && !isArray( path ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Key path must be a string or a key array. Value: `%s`.', path ) );\n\t}\n\topts = defaults();\n\tif ( arguments.length > 2 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( value === void 0 || value === null ) {\n\t\treturn false;\n\t}\n\tif ( isStr ) {\n\t\tprops = path.split( opts.sep );\n\t} else {\n\t\tprops = path;\n\t}\n\treturn has( value, props );\n}\n\n\n// EXPORTS //\n\nmodule.exports = deepHasOwnProp;\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// MODULES //\n\nvar isString = require( '@stdlib/assert-is-string' ).isPrimitive;\nvar isArray = require( '@stdlib/assert-is-array' );\nvar format = require( '@stdlib/string-format' );\nvar validate = require( './validate.js' );\nvar defaults = require( './defaults.js' );\nvar has = require( './has.js' );\n\n\n// MAIN //\n\n/**\n* Returns a function which tests whether an object has a nested key path.\n*\n* @param {(string|Array)} path - key path\n* @param {Options} [options] - function options\n* @param {string} [options.sep='.'] - key path separator\n* @throws {TypeError} first argument must be a string or key array\n* @throws {TypeError} options argument must be an object\n* @throws {TypeError} must provide valid options\n* @returns {Function} function which tests whether an object has a nested key path\n*\n* @example\n* var has = factory( 'a/b/c', {\n* 'sep': '/'\n* });\n*/\nfunction factory( path, options ) {\n\tvar isStr;\n\tvar props;\n\tvar opts;\n\tvar err;\n\tisStr = isString( path );\n\tif ( !isStr && !isArray( path ) ) {\n\t\tthrow new TypeError( format( 'invalid argument. Key path must be a string or a key array. Value: `%s`.', path ) );\n\t}\n\topts = defaults();\n\tif ( arguments.length > 1 ) {\n\t\terr = validate( opts, options );\n\t\tif ( err ) {\n\t\t\tthrow err;\n\t\t}\n\t}\n\tif ( isStr ) {\n\t\tprops = path.split( opts.sep );\n\t} else {\n\t\tprops = path;\n\t}\n\treturn deepHasOwnProp;\n\n\t/**\n\t* Returns a boolean indicating whether an object has a nested key path.\n\t*\n\t* @private\n\t* @param {*} value - value to test\n\t* @returns {boolean} boolean indicating whether an object has a nested property\n\t*\n\t* @example\n\t* var obj = { 'a': { 'b': { 'c': 'd' } } };\n\t* var bool = deepHasOwnProp( obj );\n\t*/\n\tfunction deepHasOwnProp( value ) {\n\t\tif ( value === void 0 || value === null ) {\n\t\t\treturn false;\n\t\t}\n\t\treturn has( value, props );\n\t}\n}\n\n\n// EXPORTS //\n\nmodule.exports = factory;\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 whether an object contains a nested key path.\n*\n* @module @stdlib/assert-deep-has-own-property\n*\n* @example\n* var deepHasOwnProp = require( '@stdlib/assert-deep-has-own-property' );\n*\n* var obj = {\n* 'a': {\n* 'b': {\n* 'c': 'd'\n* }\n* }\n* };\n*\n* var bool = deepHasOwnProp( obj, 'a.b.c' );\n* // returns true\n*\n* bool = deepHasOwnProp( obj, [ 'a', 'b', 'c' ] );\n* // returns true\n*\n* @example\n* var factory = require( '@stdlib/assert-deep-has-own-property' ).factory;\n*\n* var has = factory( 'a/b/c', {\n* 'sep': '/'\n* });\n*\n* var obj = {\n* 'a': {\n* 'b': {\n* 'c': 'd'\n* }\n* }\n* };\n*\n* var bool = has( obj );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar factory = require( './factory.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'factory', factory );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
5
+ "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAW,QAAS,gCAAiC,EACrDC,EAAa,QAAS,iCAAkC,EACxDC,EAAS,QAAS,uBAAwB,EAwB9C,SAASC,EAAUC,EAAMC,EAAU,CAClC,OAAML,EAAUK,CAAQ,EAGnBJ,EAAYI,EAAS,KAAM,IAC/BD,EAAK,IAAMC,EAAQ,IACd,CAACN,EAAUK,EAAK,GAAI,GACjB,IAAI,UAAWF,EAAQ,8DAA+D,MAAOE,EAAK,GAAI,CAAE,EAG1G,KARC,IAAI,UAAWF,EAAQ,qEAAsEG,CAAQ,CAAE,CAShH,CAKAP,EAAO,QAAUK,ICjEjB,IAAAG,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA4BA,SAASC,GAAW,CACnB,MAAO,CACN,IAAO,GACR,CACD,CAKAD,EAAO,QAAUC,ICrCjB,IAAAC,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAa,QAAS,iCAAkC,EAa5D,SAASC,EAAgBC,EAAGC,EAAQ,CACnC,IAAIC,EAAMD,EAAM,OACZ,EACJ,GAAKC,IAAQ,EACZ,MAAO,GAER,IAAM,EAAI,EAAG,EAAIA,EAAK,IACrB,GAAKJ,EAAYE,EAAGC,EAAO,CAAE,CAAE,EAC9BD,EAAIA,EAAGC,EAAO,CAAE,CAAE,MAElB,OAAO,GAGT,MAAO,EACR,CAKAJ,EAAO,QAAUE,ICtDjB,IAAAI,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAU,QAAS,yBAA0B,EAC7CC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IACXC,EAAM,IAkDV,SAASC,EAAgBC,EAAOC,EAAMC,EAAU,CAC/C,IAAIC,EACAC,EACAC,EACAC,EAGJ,GADAH,EAAQV,EAAUQ,CAAK,EAClB,CAACE,GAAS,CAACT,EAASO,CAAK,EAC7B,MAAM,IAAI,UAAWN,EAAQ,2EAA4EM,CAAK,CAAE,EAGjH,GADAI,EAAOR,EAAS,EACX,UAAU,OAAS,IACvBS,EAAMV,EAAUS,EAAMH,CAAQ,EACzBI,GACJ,MAAMA,EAGR,OAAyBN,GAAU,KAC3B,IAEHG,EACJC,EAAQH,EAAK,MAAOI,EAAK,GAAI,EAE7BD,EAAQH,EAEFH,EAAKE,EAAOI,CAAM,EAC1B,CAKAZ,EAAO,QAAUO,IC5GjB,IAAAQ,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAW,QAAS,0BAA2B,EAAE,YACjDC,EAAU,QAAS,yBAA0B,EAC7CC,EAAS,QAAS,uBAAwB,EAC1CC,EAAW,IACXC,EAAW,IACXC,EAAM,IAqBV,SAASC,EAASC,EAAMC,EAAU,CACjC,IAAIC,EACAC,EACAC,EACAC,EAEJ,GADAH,EAAQT,EAAUO,CAAK,EAClB,CAACE,GAAS,CAACR,EAASM,CAAK,EAC7B,MAAM,IAAI,UAAWL,EAAQ,2EAA4EK,CAAK,CAAE,EAGjH,GADAI,EAAOP,EAAS,EACX,UAAU,OAAS,IACvBQ,EAAMT,EAAUQ,EAAMH,CAAQ,EACzBI,GACJ,MAAMA,EAGR,OAAKH,EACJC,EAAQH,EAAK,MAAOI,EAAK,GAAI,EAE7BD,EAAQH,EAEFM,EAaP,SAASA,EAAgBC,EAAQ,CAChC,OAAyBA,GAAU,KAC3B,GAEDT,EAAKS,EAAOJ,CAAM,CAC1B,CACD,CAKAX,EAAO,QAAUO,IC9BjB,IAAIS,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAU,IAKdF,EAAaC,EAAM,UAAWC,CAAQ,EAKtC,OAAO,QAAUD",
6
+ "names": ["require_validate", "__commonJSMin", "exports", "module", "isString", "isObject", "hasOwnProp", "format", "validate", "opts", "options", "require_defaults", "__commonJSMin", "exports", "module", "defaults", "require_has", "__commonJSMin", "exports", "module", "hasOwnProp", "deepHasOwnProp", "v", "props", "len", "require_main", "__commonJSMin", "exports", "module", "isString", "isArray", "format", "validate", "defaults", "has", "deepHasOwnProp", "value", "path", "options", "isStr", "props", "opts", "err", "require_factory", "__commonJSMin", "exports", "module", "isString", "isArray", "format", "validate", "defaults", "has", "factory", "path", "options", "isStr", "props", "opts", "err", "deepHasOwnProp", "value", "setReadOnly", "main", "factory"]
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
  /**
22
22
  * Interface defining function options.
@@ -0,0 +1,38 @@
1
+ /**
2
+ * @license Apache-2.0
3
+ *
4
+ * Copyright (c) 2023 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
+ 'use strict';
20
+
21
+ // MAIN //
22
+
23
+ /**
24
+ * Returns default options.
25
+ *
26
+ * @private
27
+ * @returns {Object} default options
28
+ */
29
+ function defaults() {
30
+ return {
31
+ 'sep': '.'
32
+ };
33
+ }
34
+
35
+
36
+ // EXPORTS //
37
+
38
+ module.exports = defaults;
package/lib/factory.js CHANGED
@@ -22,9 +22,9 @@
22
22
 
23
23
  var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
24
24
  var isArray = require( '@stdlib/assert-is-array' );
25
- var copy = require( '@stdlib/utils-copy' );
25
+ var format = require( '@stdlib/string-format' );
26
26
  var validate = require( './validate.js' );
27
- var defaults = require( './defaults.json' );
27
+ var defaults = require( './defaults.js' );
28
28
  var has = require( './has.js' );
29
29
 
30
30
 
@@ -36,7 +36,7 @@ var has = require( './has.js' );
36
36
  * @param {(string|Array)} path - key path
37
37
  * @param {Options} [options] - function options
38
38
  * @param {string} [options.sep='.'] - key path separator
39
- * @throws {TypeError} first argument must be a string primitive or key array
39
+ * @throws {TypeError} first argument must be a string or key array
40
40
  * @throws {TypeError} options argument must be an object
41
41
  * @throws {TypeError} must provide valid options
42
42
  * @returns {Function} function which tests whether an object has a nested key path
@@ -53,9 +53,9 @@ function factory( path, options ) {
53
53
  var err;
54
54
  isStr = isString( path );
55
55
  if ( !isStr && !isArray( path ) ) {
56
- throw new TypeError( 'invalid argument. Key path must be a string primitive or a key array. Value: `' + path + '`.' );
56
+ throw new TypeError( format( 'invalid argument. Key path must be a string or a key array. Value: `%s`.', path ) );
57
57
  }
58
- opts = copy( defaults );
58
+ opts = defaults();
59
59
  if ( arguments.length > 1 ) {
60
60
  err = validate( opts, options );
61
61
  if ( err ) {
package/lib/index.js CHANGED
@@ -62,15 +62,15 @@
62
62
  // MODULES //
63
63
 
64
64
  var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );
65
- var deepHasOwnProp = require( './main.js' );
65
+ var main = require( './main.js' );
66
66
  var factory = require( './factory.js' );
67
67
 
68
68
 
69
69
  // MAIN //
70
70
 
71
- setReadOnly( deepHasOwnProp, 'factory', factory );
71
+ setReadOnly( main, 'factory', factory );
72
72
 
73
73
 
74
74
  // EXPORTS //
75
75
 
76
- module.exports = deepHasOwnProp;
76
+ module.exports = main;
package/lib/main.js CHANGED
@@ -22,9 +22,9 @@
22
22
 
23
23
  var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
24
24
  var isArray = require( '@stdlib/assert-is-array' );
25
- var copy = require( '@stdlib/utils-copy' );
25
+ var format = require( '@stdlib/string-format' );
26
26
  var validate = require( './validate.js' );
27
- var defaults = require( './defaults.json' );
27
+ var defaults = require( './defaults.js' );
28
28
  var has = require( './has.js' );
29
29
 
30
30
 
@@ -37,7 +37,7 @@ var has = require( './has.js' );
37
37
  * @param {(string|Array)} path - key path
38
38
  * @param {Options} [options] - function options
39
39
  * @param {string} [options.sep='.'] - key path separator
40
- * @throws {TypeError} second argument must be a string primitive or key array
40
+ * @throws {TypeError} second argument must be a string or key array
41
41
  * @throws {TypeError} options argument must be an object
42
42
  * @throws {TypeError} must provide valid options
43
43
  * @returns {boolean} boolean indicating whether an object has a nested property
@@ -83,9 +83,9 @@ function deepHasOwnProp( value, path, options ) {
83
83
 
84
84
  isStr = isString( path );
85
85
  if ( !isStr && !isArray( path ) ) {
86
- throw new TypeError( 'invalid argument. Key path must be a string primitive or a key array. Value: `' + path + '`.' );
86
+ throw new TypeError( format( 'invalid argument. Key path must be a string or a key array. Value: `%s`.', path ) );
87
87
  }
88
- opts = copy( defaults );
88
+ opts = defaults();
89
89
  if ( arguments.length > 2 ) {
90
90
  err = validate( opts, options );
91
91
  if ( err ) {
package/lib/validate.js CHANGED
@@ -23,6 +23,7 @@
23
23
  var isString = require( '@stdlib/assert-is-string' ).isPrimitive;
24
24
  var isObject = require( '@stdlib/assert-is-plain-object' );
25
25
  var hasOwnProp = require( '@stdlib/assert-has-own-property' );
26
+ var format = require( '@stdlib/string-format' );
26
27
 
27
28
 
28
29
  // MAIN //
@@ -48,12 +49,12 @@ var hasOwnProp = require( '@stdlib/assert-has-own-property' );
48
49
  */
49
50
  function validate( opts, options ) {
50
51
  if ( !isObject( options ) ) {
51
- return new TypeError( 'invalid argument. Options argument must be an object. Value: `' + options + '`.' );
52
+ return new TypeError( format( 'invalid argument. Options argument must be an object. Value: `%s`.', options ) );
52
53
  }
53
54
  if ( hasOwnProp( options, 'sep' ) ) {
54
55
  opts.sep = options.sep;
55
56
  if ( !isString( opts.sep ) ) {
56
- return new TypeError( 'invalid option. `sep` option must be a string primitive. Option: `' + opts.sep + '`.' );
57
+ return new TypeError( format( 'invalid option. `%s` option must be a string. Option: `%s`.', 'sep', opts.sep ) );
57
58
  }
58
59
  }
59
60
  return null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@stdlib/assert-deep-has-own-property",
3
- "version": "0.0.6",
3
+ "version": "0.1.0",
4
4
  "description": "Test whether an object contains a nested key path.",
5
5
  "license": "Apache-2.0",
6
6
  "author": {
@@ -37,21 +37,22 @@
37
37
  "url": "https://github.com/stdlib-js/stdlib/issues"
38
38
  },
39
39
  "dependencies": {
40
- "@stdlib/assert-has-own-property": "^0.0.x",
41
- "@stdlib/assert-is-array": "^0.0.x",
42
- "@stdlib/assert-is-plain-object": "^0.0.x",
43
- "@stdlib/assert-is-string": "^0.0.x",
44
- "@stdlib/utils-copy": "^0.0.x",
45
- "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.x"
40
+ "@stdlib/assert-has-own-property": "^0.1.0",
41
+ "@stdlib/assert-is-array": "^0.1.0",
42
+ "@stdlib/assert-is-plain-object": "^0.1.0",
43
+ "@stdlib/assert-is-string": "^0.1.0",
44
+ "@stdlib/string-format": "^0.1.0",
45
+ "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0",
46
+ "@stdlib/error-tools-fmtprodmsg": "^0.1.0"
46
47
  },
47
48
  "devDependencies": {
48
- "@stdlib/assert-is-boolean": "^0.0.x",
49
- "@stdlib/assert-is-function": "^0.0.x",
50
- "@stdlib/bench": "^0.0.x",
51
- "@stdlib/random-base-randu": "^0.0.x",
49
+ "@stdlib/assert-is-boolean": "^0.1.0",
50
+ "@stdlib/assert-is-function": "^0.1.0",
51
+ "@stdlib/bench": "^0.1.0",
52
+ "@stdlib/random-base-randu": "^0.0.8",
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"
55
56
  },
56
57
  "engines": {
57
58
  "node": ">=0.10.0",
@@ -94,7 +95,7 @@
94
95
  "hasownproperty"
95
96
  ],
96
97
  "funding": {
97
- "type": "patreon",
98
- "url": "https://www.patreon.com/athan"
98
+ "type": "opencollective",
99
+ "url": "https://opencollective.com/stdlib"
99
100
  }
100
101
  }
package/docs/repl.txt DELETED
@@ -1,73 +0,0 @@
1
-
2
- {{alias}}( value, path[, options] )
3
- Returns a boolean indicating whether an object contains a nested key path.
4
-
5
- The function tests for "own" properties and will return `false` for
6
- inherited properties.
7
-
8
- Value arguments other than `null` or `undefined` are coerced to objects.
9
-
10
- Key path array elements are coerced to strings.
11
-
12
- Parameters
13
- ----------
14
- value: any
15
- Value to test.
16
-
17
- path: string|Array
18
- Key path.
19
-
20
- options: Object (optional)
21
- Options.
22
-
23
- options.sep: string (optional)
24
- Key path separator. Default: '.'.
25
-
26
- Returns
27
- -------
28
- bool: boolean
29
- Boolean indicating if an object has a specified path.
30
-
31
- Examples
32
- --------
33
- > var obj = { 'a': { 'b': { 'c': 'd' } } };
34
- > var bool = {{alias}}( obj, 'a.b.c' )
35
- true
36
-
37
- // Specify a custom separator via the `sep` option:
38
- > obj = { 'a': { 'b': { 'c': 'd' } } };
39
- > bool = {{alias}}( obj, 'a/b/c', { 'sep': '/' } )
40
- true
41
-
42
- {{alias}}.factory( path[, options] )
43
- Returns a function which tests whether an object contains a nested key path.
44
-
45
- The returned function tests for "own" properties and will return `false` for
46
- inherited properties.
47
-
48
- Parameters
49
- ----------
50
- path: string|Array
51
- Key path.
52
-
53
- options: Object (optional)
54
- Options.
55
-
56
- options.sep: string (optional)
57
- Key path separator. Default: '.'.
58
-
59
- Returns
60
- -------
61
- out: Function
62
- Function which tests whether an object contains a nested key path.
63
-
64
- Examples
65
- --------
66
- > var has = {{alias}}.factory( 'a/b/c', { 'sep': '/' } );
67
- > var obj = { 'a': { 'b': { 'c': 'd' } } };
68
- > var bool = has( obj )
69
- true
70
-
71
- See Also
72
- --------
73
-
@@ -1,111 +0,0 @@
1
- /*
2
- * @license Apache-2.0
3
- *
4
- * Copyright (c) 2021 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 deepHasOwnProp = require( './index' );
20
-
21
-
22
- // TESTS //
23
-
24
- // The function returns a boolean...
25
- {
26
- const obj = { 'a': { 'b': { 'c': 'd' } } };
27
- deepHasOwnProp( obj, 'a.b.c' ); // $ExpectType boolean
28
- deepHasOwnProp( obj, 'a.b.d' ); // $ExpectType boolean
29
- deepHasOwnProp( obj, 'a/b/c', { 'sep': '/' } ); // $ExpectType boolean
30
- }
31
-
32
- // The compiler throws an error if the function is provided a second argument which is neither a string nor an array of strings...
33
- {
34
- const obj = { 'a': { 'b': { 'c': 'd' } } };
35
- deepHasOwnProp( obj, {} ); // $ExpectError
36
- deepHasOwnProp( obj, false ); // $ExpectError
37
- deepHasOwnProp( obj, true ); // $ExpectError
38
- deepHasOwnProp( obj, null ); // $ExpectError
39
- deepHasOwnProp( obj, 123 ); // $ExpectError
40
- deepHasOwnProp( obj, ( x: number ): number => x ); // $ExpectError
41
- }
42
-
43
- // The compiler throws an error if the function is provided a third argument which is not an object...
44
- {
45
- const obj = { 'a': { 'b': { 'c': 'd' } } };
46
- deepHasOwnProp( obj, 'a.b.c', 'abc' ); // $ExpectError
47
- deepHasOwnProp( obj, 'a.b.c', false ); // $ExpectError
48
- deepHasOwnProp( obj, 'a.b.c', true ); // $ExpectError
49
- deepHasOwnProp( obj, 'a.b.c', null ); // $ExpectError
50
- deepHasOwnProp( obj, 'a.b.c', 123 ); // $ExpectError
51
- deepHasOwnProp( obj, 'a.b.c', [] ); // $ExpectError
52
- deepHasOwnProp( obj, 'a.b.c', ( x: number ): number => x ); // $ExpectError
53
- }
54
-
55
- // The compiler throws an error if the function is provided a `sep` option which is not a string...
56
- {
57
- const obj = { 'a': { 'b': { 'c': 'd' } } };
58
- deepHasOwnProp( obj, 'a/b/c', { 'sep': 123 } ); // $ExpectError
59
- deepHasOwnProp( obj, 'a/b/c', { 'sep': true } ); // $ExpectError
60
- deepHasOwnProp( obj, 'a/b/c', { 'sep': false } ); // $ExpectError
61
- deepHasOwnProp( obj, 'a/b/c', { 'sep': {} } ); // $ExpectError
62
- deepHasOwnProp( obj, 'a/b/c', { 'sep': [] } ); // $ExpectError
63
- deepHasOwnProp( obj, 'a/b/c', { 'sep': ( x: number ): number => x } ); // $ExpectError
64
- }
65
-
66
- // Attached to main export is a `factory` method which returns a function...
67
- {
68
- deepHasOwnProp.factory( 'a.b.c' ); // $ExpectType HasFunction
69
- }
70
-
71
- // The compiler throws an error if the `factory` method is provided an unsupported number of arguments...
72
- {
73
- deepHasOwnProp.factory(); // $ExpectError
74
- deepHasOwnProp.factory( 'a.b.c', {}, {} ); // $ExpectError
75
- }
76
-
77
- // The `factory` method returns a function which returns a boolean...
78
- {
79
- const obj = { 'a': { 'b': { 'c': 'd' } } };
80
- const has = deepHasOwnProp.factory( 'a.b.c' ); // $ExpectType HasFunction
81
- has( obj ); // $ExpectType boolean
82
- has( {} ); // $ExpectType boolean
83
- }
84
-
85
- // The compiler throws an error if the `factory` method is provided a first argument which is neither a string nor an array of strings...
86
- {
87
- deepHasOwnProp.factory( {} ); // $ExpectError
88
- deepHasOwnProp.factory( false ); // $ExpectError
89
- deepHasOwnProp.factory( true ); // $ExpectError
90
- deepHasOwnProp.factory( null ); // $ExpectError
91
- deepHasOwnProp.factory( 123 ); // $ExpectError
92
- deepHasOwnProp.factory( ( x: number ): number => x ); // $ExpectError
93
- }
94
-
95
- // The compiler throws an error if the `factory` method is provided a `sep` option which is not a string...
96
- {
97
- deepHasOwnProp.factory( 'a/b/c', { 'sep': true } ); // $ExpectError
98
- deepHasOwnProp.factory( 'a/b/c', { 'sep': false } ); // $ExpectError
99
- deepHasOwnProp.factory( 'a/b/c', { 'sep': 123 } ); // $ExpectError
100
- deepHasOwnProp.factory( 'a/b/c', { 'sep': [] } ); // $ExpectError
101
- deepHasOwnProp.factory( 'a/b/c', { 'sep': {} } ); // $ExpectError
102
- deepHasOwnProp.factory( 'a/b/c', { 'sep': ( x: number ): number => x } ); // $ExpectError
103
- }
104
-
105
- // The compiler throws an error if the function is provided an unsupported number of arguments...
106
- {
107
- const obj = { 'a': { 'b': { 'c': 'd' } } };
108
- deepHasOwnProp(); // $ExpectError
109
- deepHasOwnProp( obj ); // $ExpectError
110
- deepHasOwnProp( obj, 'a.b.c', {}, 123 ); // $ExpectError
111
- }
package/lib/defaults.json DELETED
@@ -1,3 +0,0 @@
1
- {
2
- "sep": "."
3
- }