DoneJS StealJS jQuery++ FuncUnit DocumentJS
6.6.1
5.33.3 4.3.0 3.14.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-deep-observable
      • can-define
        • static
          • types
        • types
          • PropDefinition
          • ValueOptions
        • behaviors
          • default
          • Default
          • get
          • identity
          • serialize
          • set
          • type
          • Type
          • value
      • 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-compat
      • can-map-define
      • can-observable-array
      • can-observable-object
      • can-observation
      • can-observation-recorder
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
      • can-value
    • Views
      • can-attribute-observable
      • can-component
      • can-observable-bindings
      • can-stache
      • can-stache-bindings
      • can-stache-converters
      • can-stache-element
      • can-stache-route-helpers
      • can-view-autorender
      • can-view-callbacks
      • can-view-import
      • can-view-live
      • can-view-model
      • can-view-parser
      • can-view-scope
      • can-view-target
      • steal-stache
    • Data Modeling
      • can-connect
      • can-connect-ndjson
      • can-connect-tag
      • can-define-realtime-rest-model
      • can-define-rest-model
      • can-fixture
      • can-fixture-socket
      • can-local-store
      • can-memory-store
      • can-ndjson-stream
      • can-query-logic
      • can-realtime-rest-model
      • can-rest-model
      • can-set-legacy
      • can-super-model
    • 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
    • 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-type
      • 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

types

  • Edit on GitHub

Specify a type to convert values to. Type coercion only applies when setting a property. All types leave null and undefined as is except for the "htmlbool" type converter.

Object

All of the following type names can be used as part of a type property behavior like:

DefineMap.extend({
    age: {type: "number"}
});

Or they can be used in the type property definition shorthand:

DefineMap.extend({
    age: "number"
});

Options

  • observable {function}:

    The default type behavior. It converts plain Objects to DefineMaps and plain Arrays to DefineLists. Everything else is left as is.

  • any {function}:

    Leaves the set value as is, performs no type conversion. Aliased as *.

  • string {function}:

    Converts to a string with ""+val. This is the equivalent to MaybeString.

  • date {function}:

    Converts to a JavaScript date using Date.parse(val) if a string is given or new Date(val) if a number is passed. This is the equivalent to MaybeDate.

  • number {function}:

    Converts to a number with +(val). This is the equivalent to MaybeNumber.

  • boolean {function}:

    Converts to false if val is falsey, "0", or "false"; otherwise, converts to true. This is the equivalent to MaybeBoolean.

  • htmlbool {function}:

    Like boolean, but converts to true if empty string ("") is passed.

  • compute {function}:

    Allows computes to be passed and the property take on the value of the compute.

  • stringOrObservable {function}:

    Converts plain Objects to DefineMaps, plain Arrays to DefineLists and everything else to strings. This is useful for routing.

Use

Use any of the type names on a PropDefinition's type or directly on the prototype of a DefineMap or DefineList.

import {DefineMap} from "can";

const Person = DefineMap.extend( {
    age: "number"
} );

const person = new Person( {age: "30"} );

console.log( person.age ); //-> 30

You can also pass these functions in directly:

import {DefineMap, define} from "can";

const Person = DefineMap.extend( {
    age: define.types.number
} );

const person = new Person( {age: "30"} );

console.log( person.age ); //-> 30

And you can use the can-data-types types too:

import {DefineMap, MaybeNumber} from "can";

const Person = DefineMap.extend( {
    age: MaybeNumber
} );

const person = new Person({age: "30"});

console.log( person.age ); //-> 30

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

On this page

Get help

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