RAMEN Core
    Preparing search index...

    Variable DataTypesConst

    DataTypes: {
        Boolean: "Boolean";
        Float: "Float";
        Integer: "Integer";
        Object: "Object";
        String: "String";
    } = ...

    Built-in data type references for attributes and custom data type bases.

    Reference Accepted value
    DataTypes.String Text
    DataTypes.Boolean true or false
    DataTypes.Integer A whole number
    DataTypes.Float A finite number, including fractions
    DataTypes.Object A JSON object value, excluding arrays and null; it has no model identity or relations

    Use these references with Modeller.createAttribute or Modeller.createDataType. For attributes using declared types, pass a DataType or a DataTypeSuggestion instead.

    Type Declaration

    • ReadonlyBoolean: "Boolean"

      Boolean values, serialised as the built-in reference Boolean.

    • ReadonlyFloat: "Float"

      Finite numbers, serialised as the built-in reference Float.

    • ReadonlyInteger: "Integer"

      Whole numbers, serialised as the built-in reference Integer.

    • ReadonlyObject: "Object"

      JSON object values, serialised as the built-in reference Object.

    • ReadonlyString: "String"

      Text values, serialised as the built-in reference String.

    model.createAttribute(document, { name: 'title', typeId: DataTypes.String });