Bitovi

types

Defines the type, initial value, and get, set, and serialize behavior for an observable property. All type converters leave null and undefined as is except for the "htmlbool" type converter.

`Object`

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.
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.
number {function}:
Converts to a number with +(val).
boolean {function}:
Converts to false if val is falsey, "0", or "false"; otherwise, converts to true.
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 define from "can-define";
import DefineMap from "can-define/map/map";

const Animal = function( name ) {
    this.name = name;
};
define( Animal.prototype, {
    name: { type: "string" }
} );

const Person = DefineMap.extend( {
    name: "string"
} );

You can also pass these functions in directly:

import define from "can-define";
import DefineMap from "can-define/map/map";

const Animal = function( name ) {
    this.name = name;
};
define( Animal.prototype, {
    name: { type: define.type.string }
} );

const Person = DefineMap.extend( {
    name: define.type.string
} );

types

Object

Options

Use

Get help

`Object`