DoneJS StealJS jQuery++ FuncUnit DocumentJS
3.14.1
5.0.0 4.3.0 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-compute
      • can-define
      • can-define/list/list
      • can-define/map/map
      • can-define-stream
      • can-define-stream-kefir
      • can-event
      • can-event/async/async
      • can-event/batch/batch
      • can-event/lifecycle/lifecycle
      • can-kefir
      • can-list
      • can-map
      • can-map-backup
      • can-map-define
      • can-observation
      • can-observe
      • can-simple-map
      • can-simple-observable
      • can-stream
      • can-stream-kefir
    • Data Modeling
      • can-connect
      • can-connect-cloneable
      • can-connect-feathers
      • can-connect-ndjson
      • can-connect-signalr
      • can-fixture
      • can-fixture-socket
      • can-ndjson-stream
      • can-set
    • Views
      • can-component
      • can-ejs
      • can-element
      • can-react-component
      • can-stache
      • can-stache/helpers/route
      • can-stache-bindings
      • can-stache-converters
      • can-view-autorender
      • can-view-callbacks
      • can-view-href
      • 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-pushstate
    • JS Utilities
      • can-assign
      • can-define-lazy-value
      • can-globals
      • can-key-tree
      • can-make-map
      • can-parse-uri
      • can-string
      • can-string-to-any
      • can-util
      • can-zone
      • can-zone-storage
    • DOM Utilities
      • can-ajax
      • can-attribute-encoder
      • can-control
      • can-dom-events
      • can-event-dom-enter
      • can-event-dom-radiochange
      • can-jquery
    • 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-namespace
      • can-reflect
        • Type reflections
          • isBuiltIn
          • isConstructorLike
          • isFunctionLike
          • isIteratorLike
          • isListLike
          • isMapLike
          • isMoreListLikeThanMapLike
          • isObservableLike
          • isPlainObject
          • isPrimitive
          • isPromise
          • isSymbolLike
          • isValueLike
        • Get/Set reflections
          • deleteKeyValue
          • getKeyValue
          • getValue
          • setKeyValue
          • setValue
        • Call reflections
          • apply
          • call
          • new
        • Shape reflections
          • assign
          • assignDeep
          • assignSymbols
          • cloneKeySort
          • convert
          • defineInstanceKey
          • each
          • eachIndex
          • eachKey
          • getIdentity
          • getName
          • getOwnEnumerableKeys
          • getOwnKeyDescriptor
          • getOwnKeys
          • getSchema
          • hasKey
          • hasOwnKey
          • serialize
          • setName
          • size
          • toArray
          • unwrap
          • update
          • updateDeep
        • Observable reflections
          • getPriority
          • getKeyDependencies
          • getValueDependencies
          • isBound
          • keyHasDependencies
          • offInstanceBoundChange
          • offInstancePatches
          • offKeyValue
          • offPatches
          • offEvent
          • onEvent
          • onInstanceBoundChange
          • onInstancePatches
          • onKeyValue
          • onKeys
          • onKeysAdded
          • onKeysRemoved
          • onPatches
          • onValue
          • valueHasDependencies
          • setPriority
      • 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

convert

  • Edit on GitHub

Convert one value to another type.

convert(value, Type)

convert attempts to convert value to the type specified by Type.

import canRefect from "can-reflect";

canReflect.convert("1", Number) //-> 1

convert works by performing the following logic:

  1. If the Type is a primitive like Number, String, Boolean, the value will be passed to the Type function and the result returned.
    return Type(value);
    
  2. The value will be checked if it is already an instance of the type by performing the following:
    1. If the Type has a can.isMember symbol value, that value will be used to determine if the value is already an instance.
    2. If the Type is a isConstructorLike function, instanceof Type will be used to check if value is already an instance.
  3. If value is already an instance, value will be returned.
  4. If Type has a can.new symbol, value will be passed to it and the result returned.
  5. If Type is a isConstructorLike function, new Type(value) will be called the the result returned.
  6. If Type is a regular function, Type(value) will be called and the result returned.
  7. If a value hasn't been returned, an error is thrown.

Parameters

  1. value {Object|Primitive}:

    A value to be converted.

  2. Type {Object|function}:

    A constructor function or an object that implements the necessary symbols.

Returns

{Object}:

The value converted to a member of Type.

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

On this page

Get help

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