can

<!DOCTYPE html>  <html lang="en"> <head> <meta charset="utf-8"> <title>CanJS - can-construct</title> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <link rel="stylesheet" type="text/css" href="./static/bundles/bit-docs-site/static.css"> <link rel="shortcut icon" sizes="16x16 24x24 32x32 48x48 64x64" href="/docs/images/canjs_favicon.ico"> <link rel="apple-touch-icon" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon-precomposed" sizes="57x57" href="../docs/images/canjs_favicon_57x57.png"> <link rel="apple-touch-icon" sizes="72x72" href="../docs/images/canjs_favicon_72x72.png"> <link rel="apple-touch-icon" sizes="114x114" href="../docs/images/canjs_favicon_114x114.png"> <link rel="apple-touch-icon" sizes="120x120" href="../docs/images/canjs_favicon_128x128.png"> <link rel="apple-touch-icon" sizes="144x144" href="../docs/images/canjs_favicon_144x144.png"> <link rel="apple-touch-icon" sizes="152x152" href="../docs/images/canjs_favicon_152x152.png"> <meta content="yes" name="apple-mobile-web-app-capable"> <meta name="apple-mobile-web-app-status-bar-style" content="white-translucent"> <script> (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) })(window,document,'script','https://www.google-analytics.com/analytics.js','ga'); ga('create', 'UA-2302003-11', 'auto'); ga('send', 'pageview'); </script> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger"/> <label for="nav-trigger">Menu</label> <div id="everything"> <div id="left" class="column"> <div class="top-left"> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> <div class="dropdown project-dropdown"> <a href="https://donejs.com/">DoneJS</a> <a href="http://stealjs.com/">StealJS</a> <a href="http://jquerypp.com/">jQuery ++</a> <a href="https://funcunit.com/">FuncUnit</a> <a href="http://documentjs.com/">DocumentJS</a> </div> </div> <div class="version"> <div class="version-number"> 3.0.0 </div> <div class="dropdown version-dropdown"> <a href="https://v2.canjs.com">2.3.27</a> </div> </div> </div> <div class="search-bar"> <p>   </p> </div> </div> <div class="bottom-left"> <div class="social-side-container"> <ul class="social-side"> <li> <a class="header-mobile github" href="https://github.com/canjs/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/github.png">Github</a> </li> <li> <a class="header-mobile twitter" href="https://twitter.com/canjs" target="_blank"><img class="social-icon-small" src="../docs/images/twitter.png">Twitter</a> </li> </ul> <ul class="social-side"> <li> <a class="header-mobile" href="https://gitter.im/canjs/canjs" target="_blank">Chat</a> </li> <li> <a class="header-mobile" href="http://forums.donejs.com/c/canjs" target="_blank">Forum</a> </li> </ul> </div> <ul> <li class=" "> <a class="page" href="guides.html" title="Welcome to CanJS! These guides are here to help you develop and improve your relationship with CanJS. After all, picking a JavaScript framework is a commitment. We want CanJS to be the framework you marry. This page helps you know how advance through the different stages of this relationship:"> Guides </a> </li> <li class=" "> <a class="page" href="can-core.html" title="The best, most hardened and generally useful libraries in CanJS."> Core </a> </li> <li class=" "> <a class="page" href="can-ecosystem.html" title="Useful libraries that extend or add important features to the core collection."> Ecosystem </a> </li> <li class=" parent expanded"> <a class="page" href="can-infrastructure.html" title="Utility libraries that power the core and ecosystem collection."> Infrastructure </a> <ul> <li class="current parent expanded"> <a class="module" href="can-construct.html" title="Provides a way to easily use the power of prototypal inheritance without worrying about hooking up all the particulars yourself. Use can-construct.extend to create an inheritable constructor function of your own."> can-construct </a> <ul> <li> <span>prototype</span> <ul> <li class=" "> <a class="property" href="can-construct.prototype.constructor.html" title="A reference to the constructor function that created the instance. This allows you to access the constructor's static properties from an instance."> constructor </a> </li> <li class=" "> <a class="function" href="can-construct.prototype.init.html" title="Called when a new instance of a Construct is created."> init </a> </li> <li class=" "> <a class="function" href="can-construct.prototype.setup.html" title=""> setup </a> </li> </ul> </li> <li> <span>static</span> <ul> <li class=" "> <a class="property" href="can-construct.constructorExtends.html" title="Toggles the behavior of a constructor function called without the new keyword to extend the constructor function or create a new instance. var animal = Animal(); // vs var animal = new Animal();"> constructorExtends </a> </li> <li class=" "> <a class="function" href="can-construct.extend.html" title=""> extend </a> </li> <li class=" "> <a class="function" href="can-construct.newInstance.html" title="Returns an instance of Construct. This method can be overridden to return a cached instance."> newInstance </a> </li> <li class=" "> <a class="function" href="can-construct.setup.html" title="Perform initialization logic for a constructor function."> setup </a> </li> <li class=" "> <a class="property" href="can-construct.shortName.html" title="If you pass a name when creating a Construct, the shortName property will be set to the name."> shortName </a> </li> </ul> </li> </ul> </li> <li class=" "> <a class="module" href="can-control.html" title="Create organized, memory-leak free, rapidly performing, stateful controls with declarative event binding. Use Control to create UI controls like tabs, grids, and context menus, and organize them into higher-order business rules with can.route. It can serve as both a traditional view and a traditional controller."> can-control </a> </li> <li class=" "> <a class="module" href="can-event.html" title="Add event functionality into your objects. The canEvent object provides a number of methods for handling events in objects. This functionality is best used by mixing the canEvent object into an object or prototype. However, event listeners can still be used even on objects that don't include canEvent. All methods provided by canEvent assume that they are mixed into an object -- this should be the object dispatching the events."> can-event </a> </li> <li class=" "> <a class="module" href="can-event/async/async.html" title="Makes the event system asynchronous. WARNING: This is experimental technology."> can-event/async/async </a> </li> <li class=" "> <a class="module" href="can-event/batch/batch.html" title="Adds task batching abilities to event dispatching."> can-event/batch/batch </a> </li> <li class=" "> <a class="module" href="can-observation.html" title="Provides a mechanism to notify when an observable has been read and a way to observe those reads called within a given function."> can-observation </a> </li> <li class=" "> <a class="module" href="can-simple-map.html" title="A performant live-bound map."> can-simple-map </a> </li> <li class=" "> <a class="page" href="can-util.html" title="A set of utilities."> can-util </a> </li> <li class=" "> <a class="module" href="can-view-callbacks.html" title="Registered callbacks for behaviors"> can-view-callbacks </a> </li> <li class=" "> <a class="module" href="can-view-live.html" title="Setup live-binding between the DOM and a compute manually."> can-view-live </a> </li> <li class=" "> <a class="module" href="can-view-model.html" title="Gets the ViewModel of an element."> can-view-model </a> </li> <li class=" "> <a class="module" href="can-view-nodelist.html" title="Adds nesting of text nodes can.view.nodeLists are used to make sure "directly nested" live-binding sections update content correctly. Consider the following template: <div> {{#if items.length}} Items: {{#items}} <label></label> {{/items}} {{/if}} </div> The {{#if}} and {{#items}} seconds are "directly nested" because they share the same <div> parent element. If {{#items}} changes the DOM by adding more <labels>, {{#if}} needs to know about the <labels> to remove them if {{#if}} is re-rendered. {{#if}} would be re-rendered, for example, if all items were removed."> can-view-nodelist </a> </li> <li class=" "> <a class="module" href="can-view-parser.html" title="Parse HTML and mustache tokens."> can-view-parser </a> </li> <li class=" "> <a class="module" href="can-view-scope.html" title="Create a lookup node for keys."> can-view-scope </a> </li> <li class=" "> <a class="module" href="can-view-target.html" title=""> can-view-target </a> </li> </ul> </li> <li class=" "> <a class="page" href="can-legacy.html" title="Former libraries that we still accept patches for, but are not under active development."> Legacy </a> </li> </ul> </div> </div> <div id="right" class="column"> <div class="top-right"> <div class="top-right-top"> <ul class="top-right-bitovi"> <li class="dropdown"> <a href="http://bitovi.com" class="bitovi icon-bits">Bitovi</a> <ul class="dropdown-menu"> <li><a href="http://bitovi.com">Bitovi.com</a></li> <li><a href="http://bitovi.com/blog/">Blog</a></li> <li><a href="http://bitovi.com/consulting/">Consulting</a></li> <li><a href="http://bitovi.com/training/">Training</a></li> <li><a href="http://bitovi.com/open-source/">Open Source</a></li> </ul> </li> </ul> <div class="brand"> <div class="logo"> <a href="../index.html" alt="CanJS"></a> </div> </div> <ul class="top-right-links"> <li> <a href="https://gitter.im/canjs/canjs">Chat</a> </li> <li> <a href="http://forums.donejs.com/c/canjs">Forum</a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/canjs" data-count-href="/canjs/canjs/stargazers" data-count-api="/repos/canjs/canjs#stargazers_count">Star</a> </li> <li> <a href="https://twitter.com/canjs" class="twitter-follow-button nav-social" data-show-count="true" data-show-screen-name="false">Follow @canjs</a><script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script> </li> </ul> </div> <div class="breadcrumb"> <li><a href="../index.html">CanJS</a></li> / <li><a href="can-infrastructure.html">Infrastructure</a></li> / <li><a href="can-construct.html">can-construct</a></li> <li class="breadcrumb-dropdown">/ <a> On this page</a> <ul class="on-this-page"></ul> </li> <div class="nav-toggle" title="Back to top"></div> </div> </div> <div class="bottom-right"> <article> <section class="title"> <div class="page-type"> <h1>can-construct</h1> <div>module</div> </div> <section class="description"> <p>Provides a way to easily use the power of prototypal inheritance without worrying about hooking up all the particulars yourself. Use <a href="can-construct.extend.html" title="">can-construct.extend</a> to create an inheritable constructor function of your own.</p> </section> </section> <section class="on-this-page-table"> </section> <section class="title-footer"> <ul class="title-social"> <li> <a class="npm-button" href="https://www.npmjs.com/package/can-construct"> <img src="https://img.shields.io/badge/npm%20package-3.0.3-brightgreen.svg" alt="npm package badge" /> </a> </li> <li> <a class="github-button nav-social" href="https://github.com/canjs/can-construct" data-count-href="/canjs/can-construct/stargazers" data-count-api="/repos/canjs/can-construct#stargazers_count">Star</a> </li> </ul> <ul class="title-links">  <li><a href="//github.com/canjs/can-construct/tree/v3.0.3/docs/construct.md">source</a></li>   </ul> </section> <div class="signature"> <h2 class="signature-title"> <code>new Construct( ...args )</code> </h2> <p>Creates a new instance using Construct's constructor functions.</p> <div class="parameters"> <h3 class="parameters-title">Parameters</h3> <ol> <li><b>args</b> <code>{*}</code>: <p>The arguments passed to the constructor.</p> </li> </ol> </div> <div class="returns"> <h3 class="returns-title">Returns</h3> <p> <code>{Object}</code>: <p>The instantiated object.</p> </p> </div> </div> <section class="body"> <h2>Use</h2> <p>In the example below, <code>Animal</code> is a constructor function returned by <a href="can-construct.extend.html" title="">can-construct.extend</a>. All instances of <code>Animal</code> will have a <code>speak</code> method, and the <code>Animal</code> constructor has a <code>legs</code> property.</p> <pre><code class="language-js">var Construct = require("can-construct"); var Animal = Construct.extend({ legs: 4 }, { speak: function() { console.log(this.sound); } }); </code></pre> <p>An optional <a href="can-construct.prototype.setup.html" title="">setup</a> function can be specified to handle the instantiation of the constructor function.</p> <pre><code class="language-js">var Animal = Construct.extend({ legs: 4, setup: function(sound) { return [sound] } }, { speak: function() { console.log(this.sound); } }); </code></pre> <p><a href="can-construct.prototype.setup.html" title="">setup</a> returns {Array|undefined} If an array is returned, the array's items are passed as arguments to <a href="can-construct.prototype.init.html" title="Called when a new instance of a Construct is created.">init</a>.</p> <p>In addition <a href="can-construct.prototype.init.html" title="Called when a new instance of a Construct is created.">init</a> can be specified which is a method that gets called with each new instance.</p> <pre><code class="language-js">var Animal = Construct.extend({ legs: 4, init: function(sound) { this.sound = sound; } }, { speak: function() { console.log(this.sound); } }); </code></pre> <p>For more information on deciding when to use <a href="can-construct.prototype.setup.html" title="">setup</a> or <a href="can-construct.prototype.init.html" title="Called when a new instance of a Construct is created.">init</a> see the bottom of the <a href="can-construct.prototype.setup.html" title="">setup</a> documentation.</p> <p>You can make instances of your object by calling your constructor function with the <code>new</code> keyword. When an object is created, the <a href="can-construct.prototype.init.html" title="Called when a new instance of a Construct is created.">init</a> method gets called (if you supplied one):</p> <pre><code class="language-js">var panther = new Animal('growl'); panther.speak(); // "growl" panther instanceof Animal; // true </code></pre> <h2>Plugins</h2> <p>There are plugins available to help make using <code>can-construct</code> even simpler.</p> <ul> <li><a href="can-construct-super.html" title="can.Construct.super is a plugin that makes it easier to call base functions from inside inheriting functions.">can-construct-super</a> allows you to easily call base methods by making <code>this._super</code> available in inherited methods.</li> </ul> </section> <script type="text/javascript"> var docObject = {"name":"can-construct","type":"module","description":" \nProvides a way to easily use the power of prototypal inheritance\nwithout worrying about hooking up all the particulars yourself. Use\n[can-construct.extend can-construct.extend] to create an inheritable\nconstructor function of your own.\n\n","src":{"path":"node_modules/can-construct/docs/construct.md"},"title":"can-construct","types":[{"type":"function","returns":{"types":[{"type":"undefined"}]},"params":[]}],"parent":"can-infrastructure","package":{"_args":[[{"raw":"can-construct@3.0.3","scope":null,"escapedName":"can-construct","name":"can-construct","rawSpec":"3.0.3","spec":"3.0.3","type":"version"},"/Users/kevin/dev/canjs"]],"_from":"can-construct@3.0.3","_id":"can-construct@3.0.3","_inCache":true,"_location":"/can-construct","_nodeVersion":"6.9.1","_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/can-construct-3.0.3.tgz_1478545674260_0.6723458541091532"},"_npmUser":{"name":"phillipskevin","email":"kphillips86@gmail.com"},"_npmVersion":"3.10.8","_phantomChildren":{},"_requested":{"raw":"can-construct@3.0.3","scope":null,"escapedName":"can-construct","name":"can-construct","rawSpec":"3.0.3","spec":"3.0.3","type":"version"},"_requiredBy":["/","/can-component","/can-construct-super","/can-control","/can-define","/can-list","/can-map","/can-simple-map","/can-view-scope"],"_resolved":"https://registry.npmjs.org/can-construct/-/can-construct-3.0.3.tgz","_shasum":"c7c8ff1a9b45502bd832a1a28ec4801be2b147bb","_shrinkwrap":null,"_spec":"can-construct@3.0.3","_where":"/Users/kevin/dev/canjs","author":{"name":"Bitovi","email":"contact@bitovi.com","url":"http://bitovi.com"},"bit-docs":{"dependencies":{"bit-docs-glob-finder":"^0.0.5","bit-docs-dev":"^0.0.3","bit-docs-js":"^0.0.3","bit-docs-generate-readme":"^0.0.8"},"glob":{"pattern":"**/*.{js,md}","ignore":"node_modules/**/*"},"readme":{"apis":"./docs/apis.json"},"parent":"can-construct"},"browser":{"transform":["cssify"]},"browserify":{"transform":["cssify"]},"bugs":{"url":"https://github.com/canjs/can-construct/issues"},"dependencies":{"can-util":"^3.0.1"},"description":"easy constructor functions","devDependencies":{"bit-docs":"0.0.7","cssify":"^1.0.2","done-serve":"^0.2.4","donejs-cli":"^0.9.5","generator-donejs":"^0.9.0","jshint":"^2.9.1","steal":"^0.16.0","steal-qunit":"^0.1.1","steal-tools":"^0.16.0","testee":"^0.2.4"},"directories":{},"dist":{"shasum":"c7c8ff1a9b45502bd832a1a28ec4801be2b147bb","tarball":"https://registry.npmjs.org/can-construct/-/can-construct-3.0.3.tgz"},"gitHead":"cb9612705b0ad6f421b203f67d1a7ffc69c8efa3","homepage":"http://canjs.com","keywords":["canjs","canjs-plugin","donejs"],"main":"can-construct","maintainers":[{"name":"daffl","email":"daff@neyeon.de"},{"name":"garrettreed","email":"garrett@garrettreed.co"},{"name":"justinbmeyer","email":"justin@bitovi.com"},{"name":"matthewp","email":"matthew@matthewphillips.info"},{"name":"phillipskevin","email":"kphillips86@gmail.com"},{"name":"sinjhin","email":"john@ardea.io"}],"name":"can-construct","optionalDependencies":{},"readme":"ERROR: No README data found!","repository":{"type":"git","url":"git://github.com/canjs/can-construct.git"},"scripts":{"build":"node build.js","develop":"done-serve --static --develop --port 8080","document":"bit-docs","jshint":"jshint *.js --config","postversion":"git push --tags && git checkout master && git branch -D release && git push","preversion":"npm test && npm run build","release:major":"npm version major && npm publish","release:minor":"npm version minor && npm publish","release:patch":"npm version patch && npm publish","release:pre":"npm version prerelease && npm publish","test":"npm run jshint && npm run testee","testee":"testee test.html --browsers firefox","version":"git commit -am \"Update dist for release\" && git checkout -b release && git add -f dist/"},"system":{"configDependencies":["live-reload"],"npmAlgorithm":"flat"},"version":"3.0.3"},"signatures":[{"code":"new Construct( ...args )","description":"\n\nCreates a new instance using Construct's constructor functions.\n","params":[{"types":[{"type":"*"}],"optional":true,"name":"args","description":"The arguments passed to the constructor."}],"returns":{"types":[{"type":"Object","options":[]}],"description":"The instantiated object.\n"}}],"_curParam":{"types":[{"type":"*"}],"optional":true,"name":"args","description":"The arguments passed to the constructor."},"_curReturn":{"types":[{"type":"Object","options":[]}],"description":"The instantiated object.\n"},"comment":" ","pathToRoot":".."}; </script> </article> <footer><p>CanJS is part of <a href="http://donejs.com" target="_blank">DoneJS</a>. Created and maintained by the core <a href="https://donejs.com/About.html#section=section_Team" target="_blank">DoneJS team</a> and <a href="http://bitovi.com" target="_blank">Bitovi</a>. <strong>Currently 3.0.0.</strong></p></footer> </div> </div> </div> <script> steal = { instantiated: { "bundles/bit-docs-site/static.css!$css" : null } }; </script> <script type='text/javascript' data-main="bit-docs-site/static" src="./static/node_modules/steal/steal.production.js"></script> <script async defer src="https://buttons.github.io/buttons.js"></script> </body> </html>