94 lines
2.8 KiB
JavaScript
94 lines
2.8 KiB
JavaScript
|
/**
|
||
|
|
* @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.
|
||
|
|
*/
|
||
|
|
|
||
|
|
'use strict';
|
||
|
|
|
||
|
|
// MODULES //
|
||
|
|
|
||
|
|
var defineProperty = require( './../../define-property' );
|
||
|
|
var validate = require( './validate.js' );
|
||
|
|
var createObject = require( './detect.js' );
|
||
|
|
|
||
|
|
|
||
|
|
// MAIN //
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Implements prototypical inheritance by replacing the prototype of one constructor with the prototype of another constructor.
|
||
|
|
*
|
||
|
|
* ## Notes
|
||
|
|
*
|
||
|
|
* - This implementation is not designed to work with ES2015/ES6 classes. For ES2015/ES6 classes, use `class` with `extends`.
|
||
|
|
* - For reference, see [node#3455](https://github.com/nodejs/node/pull/3455), [node#4179](https://github.com/nodejs/node/issues/4179), [node#3452](https://github.com/nodejs/node/issues/3452), and [node commit](https://github.com/nodejs/node/commit/29da8cf8d7ab8f66b9091ab22664067d4468461e#diff-3deb3f32958bb937ae05c6f3e4abbdf5).
|
||
|
|
*
|
||
|
|
*
|
||
|
|
* @param {(Object|Function)} ctor - constructor which will inherit
|
||
|
|
* @param {(Object|Function)} superCtor - super (parent) constructor
|
||
|
|
* @throws {TypeError} first argument must be either an object or a function which can inherit
|
||
|
|
* @throws {TypeError} second argument must be either an object or a function from which a constructor can inherit
|
||
|
|
* @throws {TypeError} second argument must have an inheritable prototype
|
||
|
|
* @returns {(Object|Function)} child constructor
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* function Foo() {
|
||
|
|
* return this;
|
||
|
|
* }
|
||
|
|
* Foo.prototype.beep = function beep() {
|
||
|
|
* return 'boop';
|
||
|
|
* };
|
||
|
|
*
|
||
|
|
* function Bar() {
|
||
|
|
* Foo.call( this );
|
||
|
|
* return this;
|
||
|
|
* }
|
||
|
|
* inherit( Bar, Foo );
|
||
|
|
*
|
||
|
|
* var bar = new Bar();
|
||
|
|
* var v = bar.beep();
|
||
|
|
* // returns 'boop'
|
||
|
|
*/
|
||
|
|
function inherit( ctor, superCtor ) {
|
||
|
|
var err = validate( ctor );
|
||
|
|
if ( err ) {
|
||
|
|
throw err;
|
||
|
|
}
|
||
|
|
err = validate( superCtor );
|
||
|
|
if ( err ) {
|
||
|
|
throw err;
|
||
|
|
}
|
||
|
|
if ( typeof superCtor.prototype === 'undefined' ) {
|
||
|
|
throw new TypeError( 'invalid argument. Second argument must have a prototype from which another object can inherit. Value: `'+superCtor.prototype+'`.' );
|
||
|
|
}
|
||
|
|
// Create a prototype which inherits from the parent prototype:
|
||
|
|
ctor.prototype = createObject( superCtor.prototype );
|
||
|
|
|
||
|
|
// Set the constructor to refer to the child constructor:
|
||
|
|
defineProperty( ctor.prototype, 'constructor', {
|
||
|
|
'configurable': true,
|
||
|
|
'enumerable': false,
|
||
|
|
'writable': true,
|
||
|
|
'value': ctor
|
||
|
|
});
|
||
|
|
|
||
|
|
return ctor;
|
||
|
|
}
|
||
|
|
|
||
|
|
|
||
|
|
// EXPORTS //
|
||
|
|
|
||
|
|
module.exports = inherit;
|