@stdlib/utils/get-prototype-of/docs/types/index.d.ts

Standard utilities.

/*
* @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 the prototype of a provided object.
*
* ## Notes
*
* -   In contrast to the native `Object.getPrototypeOf`, this function does not throw when provided `null` or `undefined`. Instead, similar to when provided any value with *no* inherited properties, the function returns `null`.
* -   Value arguments other than `null` or `undefined` are coerced to objects.
*
* @param value - input value
* @returns prototype
*
* @example
* var proto = getPrototypeOf( {} );
* // returns {}
*/
declare function getPrototypeOf( value: any ): Object | null;


// EXPORTS //

export = getPrototypeOf;