1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
/*
* @license Apache-2.0
*
* Copyright (c) 2021 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.
*/
// TypeScript Version: 2.0
/**
* Interface defining function options.
*/
interface Options {
/**
* Key path separator (default: '.').
*/
sep?: string;
}
/**
* Returns a boolean indicating whether an object has a nested key path, either own or inherited.
*
* @param value - value to test
* @returns boolean indicating whether an object has a nested property
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var bool = deepHasProp( obj );
*/
type HasFunction = ( value: any ) => boolean;
/**
* Interface for testing whether an object contains a nested key path.
*/
interface DeepHasProp {
/**
* Tests whether an object contains a nested key path, either own or inherited.
*
* ## Notes
*
* - Value arguments other than `null` or `undefined` are coerced to objects.
* - Key path array elements are coerced to strings.
*
* @param value - value to test
* @param path - key path
* @param options - function options
* @param options.sep - key path separator (default: '.')
* @throws must provide valid options
* @returns boolean indicating whether an object has a nested property
*
* @example
* function Foo() {
* return this;
* }
* Foo.prototype.b = {
* 'c': 'd'
* };
*
* var obj = {
* 'a': new Foo()
* };
*
* var bool = deepHasProp( obj, 'a.b.c' );
* // returns true
*
* @example
* var arr = [
* {
* 'a': [
* {
* 'b': [
* { 'c': 'd' },
* { 'e': 'f' }
* ]
* }
* ]
* }
* ];
* var bool = deepHasProp( arr, '0.a.0.b.0.c' );
* // returns true
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var bool = deepHasProp( obj, [ 'a', 'b', 'c' ] );
* // returns true
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var bool = deepHasProp( obj, 'a/b/c', {
* 'sep': '/'
* });
* // returns true
*/
( value: any, path: string | Array<string>, options?: Options ): boolean;
/**
* Returns a function which tests whether an object has a nested key path, either own or inherited.
*
* @param path - key path
* @param options - function options
* @param options.sep - key path separator (default: '.')
* @throws must provide valid options
* @returns function which tests whether an object has a nested key path
*
* @example
* var has = factory( 'a/b/c', {
* 'sep': '/'
* });
*/
factory( path: string | Array<string>, options?: Options ): HasFunction;
}
/**
* Tests whether an object contains a nested key path, either own or inherited.
*
* @param value - value to test
* @param path - key path
* @param options - function options
* @param options.sep - key path separator (default: '.')
* @throws must provide valid options
* @returns boolean indicating whether an object has a nested property
*
* @example
* function Foo() {
* return this;
* }
* Foo.prototype.b = {
* 'c': 'd'
* };
*
* var obj = {
* 'a': new Foo()
* };
*
* var bool = deepHasProp( obj, 'a.b.c' );
* // returns true
*
* @example
* var arr = [
* {
* 'a': [
* {
* 'b': [
* { 'c': 'd' },
* { 'e': 'f' }
* ]
* }
* ]
* }
* ];
* var bool = deepHasProp( arr, '0.a.0.b.0.c' );
* // returns true
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var bool = deepHasProp( obj, [ 'a', 'b', 'c' ] );
* // returns true
*
* @example
* var obj = { 'a': { 'b': { 'c': 'd' } } };
* var bool = deepHasProp( obj, 'a/b/c', {
* 'sep': '/'
* });
* // returns true
*/
declare var deepHasProp: DeepHasProp;
// EXPORTS //
export = deepHasProp;
|
