@foxify/odin

Odin

Odin is an implementation of Active Record pattern in TypeScript.

Table of Content

• Installation
• Usage
• Features
• TODO
• Support

Installation

Before installing, download and install Node.js. Node.js 8 or higher is required.

npm i -s @foxify/odin

Usage

const Odin = require("@foxify/odin");

const { Types } = Odin;

class User extends Odin {
}

User.schema = {
  email: Types.String.email.required,
  name: {
    first: Types.String.min(3).required,
    last: Types.String.min(3),
  }
};

Features

1. Cross DB
2. Written in ES6
3. TypeScript ready
4. Active Record pattern
5. Schema validation
6. GraphQL Schema generator (based on model schema)

TODO

• Drivers
  • MongoDB
  • MySQL
  • MariaDB
  • PostgreSQL
  • SQLite
  • Redis
  • Memory
• Relationships
  • hasMany
  • hasOne
  • hasManyThrough
  • hasOneThrough
  • Polymorphic
    • morphMany
    • morphOne
    • morphTo
    • morphManyThrough
    • morphOneThrough
    • morphToThrough
  • CRUD operations
    • Create operation
    • Read operation
    • Update operation
    • Delete operation
• Schema validation
• GraphQL support
• Full test coverage
• Model hooks
• Migrations
• Seeding

Support

If my work helps you, please consider

Changelog

v0.1.0-beta.7 - (2018-08-21)

• :beetle: GraphQL query bug fix