DoneJS StealJS jQuery++ FuncUnit DocumentJS
4.3.0
5.0.0 3.13.1 2.3.35
  • About
  • Guides
  • API Docs
  • Community
  • Contributing
  • Bitovi
    • Bitovi.com
    • Blog
    • Design
    • Development
    • Training
    • Open Source
    • About
    • Contact Us
  • About
  • Guides
  • API Docs
    • Observables
      • can-bind
      • can-compute
      • can-debug
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-backup
      • can-define-stream
      • can-define-stream-kefir
      • can-event-queue
      • can-kefir
      • can-list
      • can-map
      • can-map-define
        • Type
        • Value
        • type
        • attribute definition
        • get
        • remove
        • serialize
        • set
        • value
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Data Modeling
      • can-connect
      • can-connect-feathers
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-nodelist
      • can-view-parser
      • can-view-scope
      • can-view-target
      • react-view-model
      • react-view-model/component
      • steal-stache
    • Routing
      • can-deparam
      • can-param
      • can-route
      • can-route-hash
      • can-route-mock
      • can-route-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-diff
      • can-globals
      • can-join-uris
      • can-key
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-queues
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-child-nodes
      • can-control
      • can-dom-data
      • can-dom-events
      • can-dom-mutate
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-fragment
    • Data Validation
      • can-define-validate-validatejs
      • can-validate
      • can-validate-interface
      • can-validate-legacy
      • can-validate-validatejs
    • Typed Data
      • can-cid
      • can-construct
      • can-construct-super
      • can-data-types
      • can-namespace
      • can-reflect
      • can-reflect-dependencies
      • can-reflect-promise
      • can-types
    • Polyfills
      • can-symbol
      • can-vdom
    • Core
    • Infrastructure
      • can-global
      • can-test-helpers
    • Ecosystem
    • Legacy
  • Community
  • Contributing
  • GitHub
  • Twitter
  • Chat
  • Forum
  • News
Bitovi

type

  • Edit on GitHub

Converts a value passed to attr into an appropriate value.

Use

The type property specifies the type of the attribute. The type can be specified as either a type function that returns the type coerced value or one of the following strings:

  • "string" - Converts the value to a string except null or undefined.
  • "date" - Converts the value to a date or null if the date can not be converted.
  • "number" - Passes the value through parseFloat except for null or undefined.
  • "boolean" - Converts falsey, "false" or "0" to false and everything else to true.
  • "htmlbool" - Like boolean, but also converts empty strings to true. Used, for example, when input is from component attributes like <can-tabs reverse/>
  • "compute" - If the value set is a compute, will allow the returning of the computed value.
  • "*" - Prevents the default type coersion of converting Objects to Maps and Arrays to Lists.

Basic Example

The following example converts the count property to a number and the items property to an array:

 define: {
   count: {type: "number"},
   items: {
     type: function(newValue){
       if(typeof newValue === "string") {
         return newValue.split(",")
       } else if( Array.isArray(newValue) ) {
         return newValue;
       }
     }
   }
 }

When a user tries to set those properties like:

map.attr({count: "4", items: "1,2,3"});

The number converter will be used to turn count into 4, and the items type converter function will be used to turn items into [1,2,3].

Preventing Arrays and Objects from Automatic Conversion

When an array is passed into a Map setter, it is automatically converted into a List. Likewise, objects are converted into Map instances. This behavior can be prevented like the following:

 define: {
   locations: {type: "*"}
 }

When a user tries to set this property, the resulting value will remain an array.

map.attr('locations', [1, 2, 3]); // locations is an array, not a List

Working with the 'compute' type

Setting type as compute allows for resolving a computed property with the .attr() method.

MyMap = Map.extend({
  define: {
    value: {
      type: "compute"
    }
  }
});

var myMap = new MyMap();
var c = compute(5);

myMap.attr("value",c);
myMap.attr("value"); //-> 5

c(6);
myMap.attr("value"); //-> 6

//Be sure if setting to pass the new compute
var c2 = compute("a");
myMap.attr("value",c2);
myMap.attr("value"); //-> "a"

CanJS is part of DoneJS. Created and maintained by the core DoneJS team and Bitovi. Currently 4.3.0.

On this page

Get help

  • Chat with us
  • File an issue
  • Ask questions
  • Read latest news