-
-
Notifications
You must be signed in to change notification settings - Fork 400
/
index.d.ts
53 lines (48 loc) · 1.32 KB
/
index.d.ts
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
/*
* @license Apache-2.0
*
* Copyright (c) 2019 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// TypeScript Version: 2.0
/**
* Tests if an object's own property is read-only.
*
* @param value - value to test
* @param property - property to test
* @returns boolean indicating if an object property is read-only
*
* @example
* var defineProperty = require( `@stdlib/utils/define-property` );
*
* var obj = {
* 'boop': true
* };
*
* defineProperty( obj, 'beep', {
* 'configurable': false,
* 'enumerable': true,
* 'writable': false,
* 'value': true
* });
*
* var bool = isReadOnlyProperty( obj, 'boop' );
* // returns false
*
* bool = isReadOnlyProperty( obj, 'beep' );
* // returns true
*/
declare function isReadOnlyProperty( value: any, property: any ): boolean;
// EXPORTS //
export = isReadOnlyProperty;