From 2ec1995350db7b2c55fb26eb74df31c640265eff Mon Sep 17 00:00:00 2001 From: dgsan Date: Tue, 18 Jun 2013 12:32:42 -0600 Subject: [PATCH] Added documentation on usage of Enum. --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index de16e29..0f80e41 100644 --- a/README.md +++ b/README.md @@ -93,6 +93,20 @@ The following type-dataType combinations are supported: Example: `{ startTime : { type: Date, dataType: 'timestamp' }}` +*

Enum

+ Create an Enum using Enum factory: + +```javascript + var MOOD = schema.EnumFactory('glad', 'sad', 'mad'); + MOOD.SAD; // 'sad' + MOOD(2); // 'sad' + MOOD('SAD'); // 'sad' + MOOD('sad'); // 'sad' +``` + + * `{ mood: { type: MOOD } }` + * `{ choice: { type: schema.EnumFactory('yes', 'no', 'maybe'), null: false }` + ## MIT License ```text