can
Version:
MIT-licensed, client-side, JavaScript framework that makes building rich web applications easy.
793 lines (499 loc) • 19.2 kB
HTML
<!--####################################################################
THIS IS A GENERATED FILE -- ANY CHANGES MADE WILL BE OVERWRITTEN
INSTEAD CHANGE:
source: [object Object]
@function can-construct.prototype.init
######################################################################## -->
<html lang="en">
<head>
<meta charset="utf-8">
<title>CanJS - init</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="
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="current
parent
expanded">
<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><a href="can-construct.prototype.init.html">init</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>init</h1>
<div>function</div>
</div>
<section class="description">
<p>Called when a new instance of a Construct is created.</p>
</section>
</section>
<section class="on-this-page-table">
</section>
<section class="title-footer">
<ul class="title-links">
<!-- <li><a href="#">docco</a></li> -->
<li><a href="//github.com/canjs/can-construct/tree/v3.0.3/can-construct.js#L714">source</a></li>
<!-- <li><a href="#">download</a></li> -->
<!-- <li><a href="#">tests</a></li> -->
</ul>
</section>
<div class="signature">
<h2 class="signature-title">
<code>construct.init(...args)</code>
</h2>
<div class="parameters">
<h3 class="parameters-title">Parameters</h3>
<ol>
<li><b>args</b> <code>{*}</code>: <p>the arguments passed to the constructor (or the items of the array returned from <a href="can-construct.prototype.setup.html" title="">setup</a>)</p>
</li>
</ol>
</div>
</div>
<section class="body">
<p>If a prototype <code>init</code> method is provided, <code>init</code> is called when a new Construct is created---
after <a href="can-construct.prototype.setup.html" title="">setup</a>. The <code>init</code> method is where the bulk of your initialization code
should go. A common thing to do in <code>init</code> is save the arguments passed into the constructor.</p>
<h2>Examples</h2>
<p>First, we'll make a Person constructor that has a first and last name:</p>
<pre><code class="language-js">var Person = Construct.extend({
init: function(first, last) {
this.first = first;
this.last = last;
}
});
var justin = new Person("Justin", "Meyer");
justin.first; // "Justin"
justin.last; // "Meyer"
</code></pre>
<p>Then, we'll extend Person into Programmer, and add a favorite language:</p>
<pre><code class="language-js">var Programmer = Person.extend({
init: function(first, last, language) {
// call base's init
Person.prototype.init.apply(this, arguments);
// other initialization code
this.language = language;
},
bio: function() {
return "Hi! I'm " + this.first + " " + this.last +
" and I write " + this.language + ".";
}
});
var brian = new Programmer("Brian", "Moschel", 'ECMAScript');
brian.bio(); // "Hi! I'm Brian Moschel and I write ECMAScript.";
</code></pre>
<h2>Modified Arguments</h2>
<p><a href="can-construct.prototype.setup.html" title="">setup</a> is able to modify the arguments passed to <code>init</code>.
If you aren't receiving the arguments you passed to <code>new Construct(args)</code>,
check that they aren't being changed by <code>setup</code> along
the inheritance chain.</p>
</section>
<script type="text/javascript">
var docObject = {"type":"function","name":"can-construct.prototype.init","parent":"can-construct.prototype","src":{"line":714,"codeLine":773,"path":"node_modules/can-construct/can-construct.js"},"description":"Called when a new instance of a Construct is created. \n","title":"init","signatures":[{"code":"construct.init(...args)","description":"","params":[{"types":[{"type":"*"}],"name":"args","description":"the arguments passed to the constructor (or the items of the array returned from [can-construct::setup])\n"}]}],"_curParam":{"types":[{"type":"*"}],"name":"args","description":"the arguments passed to the constructor (or the items of the array returned from [can-construct::setup])\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>