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
|
<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# isSymbolArray
> Test if a value is an array-like object containing only [symbols][mdn-symbol].
<section class="usage">
## Usage
```javascript
var isSymbolArray = require( '@stdlib/assert/is-symbol-array' );
```
#### isSymbolArray( value )
Tests if a `value` is an array-like object containing only [symbols][mdn-symbol].
```javascript
var Symbol = require( '@stdlib/symbol/ctor' );
var bool = isSymbolArray( [ Symbol( 'beep' ), Symbol( 'boop' ) ] );
// returns true
bool = isSymbolArray( [ 'beep', 'boop' ] );
// returns false
```
#### isSymbolArray.primitives( value )
Tests if a `value` is an array-like object containing only [`symbol`][mdn-symbol] primitives.
```javascript
var Symbol = require( '@stdlib/symbol/ctor' );
var bool = isSymbolArray.primitives( [ Symbol( 'beep' ), Symbol( 'boop' ) ] );
// returns true
bool = isSymbolArray.primitives( [ Symbol( 'beep' ), Object( Symbol( 'boop' ) ) ] );
// returns false
```
#### isSymbolArray.objects( value )
Tests if a `value` is an array-like object containing only [`Symbol`][mdn-symbol] objects.
```javascript
var Symbol = require( '@stdlib/symbol/ctor' );
var bool = isSymbolArray.objects( [ Object( Symbol( 'beep' ) ), Object( Symbol( 'boop' ) ) ] );
// returns true
bool = isSymbolArray.objects( [ Symbol( 'beep' ), Symbol( 'boop' ) ] );
// returns false
```
</section>
<!-- /.usage -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var hasSymbolSupport = require( '@stdlib/assert/has-symbol-support' );
var Symbol = require( '@stdlib/symbol/ctor' );
var isSymbolArray = require( '@stdlib/assert/is-symbol-array' );
var hasSymbols = hasSymbolSupport();
var bool;
if ( hasSymbols ) {
bool = isSymbolArray( [ Symbol( 'beep' ), Symbol( 'boop' ) ] );
// returns true
bool = isSymbolArray( [ Symbol( 'beep' ), 'boop' ] );
// returns false
bool = isSymbolArray( Symbol( 'beep' ) );
// returns false
} else {
console.log( 'Environment does not support symbols.' );
}
bool = isSymbolArray( [ 'beep', 'boop' ] );
// returns false
bool = isSymbolArray( [] );
// returns false
bool = isSymbolArray( 'abc' );
// returns false
bool = isSymbolArray( null );
// returns false
```
</section>
<!-- /.examples -->
<section class="links">
[mdn-symbol]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Symbol
</section>
<!-- /.links -->
|
