nativemodels

NativeModels

Native Models provides a way to map objects and arrays of objects in a clean and typed way. The main goal is to ensure runtime type checking and consistent models for APIs.

Getting Started

import { arrayModel, objectModel } from 'nativemodels';
import { boolean, computed, date, int, string } from 'nativemodels/datatypes';

const schema = {
	firstName: string().required(),
	lastName: string().required(),
	fullName: computed((record) => `${record.firstName} ${record.lastName}`),
	typeID: int().default(2),
	isAdmin: boolean().default(false),
	accountID: int().nullable(),
	created: date().default(new Date()),
	updated: date().default(new Date()),
};

const userModel = objectModel(schema);

const johnSmith = userModel({
	firstName: 'John',
	lastName: 'Smith',
});
// => { firstName: 'John', lastName: 'Smith', fullName: 'John Smith', ...}

const usersModel = arrayModel(schema);

const users = usersModel([
	{
		firstName: 'John',
		lastName: 'Smith',
	},
	{
		firstName: 'Jane',
		lastName: 'Doe',
	},
]);

const janeDoe = userModel({
	...johnSmith,
	firstName: 'Jane',
	lastName: 'Doe',
});
// => { firstName: 'Jane', lastName: 'Doe', fullName: 'Jane Doe', ...}

Datatype API

Datatype methods that can be called or extended.

datatypes.default(defaultValue)

Sets a default value if no value is set

datatypes.nullable()

Allows the value set to be null (useful for database models)

datatypes.parse(value)

Parses the value being set. Used to extend base datatype

datatypes.required()

Forces the value to be required. Is ignored if default value is set

Datatypes

• boolean
• computed
• date
• float
• int
• string