archetype

archetype

Archetype is a runtime type-casting library. Its purpose is to compose types from existing types in a way that's easy to write and document.

const { ObjectId } = require('mongodb');
const moment = require('moment');

// `Person` is now a constructor
const Person = new Archetype({
  name: 'string',
  bandId: {
    $type: ObjectId,
    $required: true
  },
  createdAt: {
    $type: moment,
    $default: () => moment()
  }
}).compile('Person');

const test = new Person({
  name: 'test',
  bandId: '507f191e810c19729de860ea'
});

test.bandId; // Now a mongodb ObjectId
test.createdAt; // moment representing now

If casting fails, archetype throws a nice clean exception:

try {
  Person({ // <-- calling with `new` is optional
    name: 'test',
    bandId: 'ImNotAValidObjectId'
  });
} catch(error) {
  error.errors['bandId'].message; // Mongodb ObjectId error
}

Archetypes are composable, inspectable, and extendable via extends.

Changelog

0.8.0 (2017-09-21)

Features

• export CastError type (1c3a971), closes #7
• helpers: add matchType (7f5e1e8)
• unmarshal: add rudimentary support for $transform (8bdf8db)
• unmarshal: report errors from $transform (a8c9e3d)
• unmarshal: support $transform in arrays (2d11cf5)

<a name="0.6.1"></a>