@stdlib/utils
Version:
Standard utilities.
42 lines (36 loc) • 1.18 kB
TypeScript
/*
* @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: 4.1
/**
* Returns an array of an object's inherited symbol properties.
*
* ## Notes
*
* - If provided `null` or `undefined`, the function returns an empty array.
*
* @param value - input object
* @param level - inheritance level
* @throws second argument must be a positive integer
* @returns a list of inherited symbol properties
*
* @example
* var symbols = inheritedPropertySymbols( [] );
*/
declare function inheritedPropertySymbols( value: any, level?: number ): Array<symbol>;
// EXPORTS //
export = inheritedPropertySymbols;