Basic setup

1. Setting up your models

TypeScript

JavaScript

JavaScript (No decorators)

// /models/index.ts
import { Model, Field } from '@datx/core';

export class Dog extends Model {
  public static type = 'dog';

  @Field()
  public breed!: string;

  @Field()
  public name!: string;

  public get greet() {
    return `Hey, I am ${this.name} the ${this.breed}.`;
  }
}

export class Person extends Model {
  public static type = 'person';

  @Field()
  public id!: number;

  @Field()
  public name!: string;

  @Field()
  public age!: number;

  @Field({ toOne: Dog })
  public favoriteDog!: Dog | null;

  public get greet() {
    if (!this.favoriteDog) {
      return `Hey, I am ${this.name}.`;
    }

    return `Hey, I am ${this.name} and my favorite dog is ${this.favoriteDog.name}.`;
  }
}

// /models/index.js
import { Model, Field } from '@datx/core';

class Dog extends Model {
  static type = 'dog';

  @Field()
  breed;

  @Field()
  name;

  get greet() {
    return `Hey, I am ${this.breed} ${this.name}.`;
  }
}

export class Person extends Model {
  static type = 'person';

  @Field()
  id;

  @Field()
  name;

  @Field()
  age;

  get greet() {
    if (!this.favoriteDog) {
      return `Hey, I am ${this.name}.`;
    }

    return `Hey, I am ${this.name} and my favorite dog is ${this.favoriteDog.name}.`;
  }
}

// /models/index.js
import { Model, Field } from '@datx/core';

export class Dog extends Model {
  static type = 'dog';

  get greet() {
    return `Hey, I am ${this.breed} ${this.name}.`;
  }
}

Field()(Dog, 'breed');
Field()(Dog, 'name');

export class Person extends Model {
  static type = 'person';

  get greet() {
    if (!this.favoriteDog) {
      return `Hey, I am ${this.name}.`;
    }

    return `Hey, I am ${this.name} and my favorite dog is ${this.favoriteDog.name}.`;
  }
}

Field()(Person, 'id');
Field()(Person, 'age');
Field()(Person, 'name');
Field({ toOne: Dog })(Person, 'favoriteDog');

2. Setting up your collection

TypeScript

JavaScript

import { Collection } from '@datx/core';

import { Person, Dog } from './models';

export default class Family extends Collection {
  public static types = [Person, Dog];

  public get dogs() {
    return this.findAll(Dog);
  }

  public get germanShepherds() {
    return this.dogs.filter((dog) => dog.breed === 'German Shepherd');
  }

  public get minors() {
    return this.findAll(Person).filter((person) => person.age < 18);
  }
}

import { Collection } from '@datx/core';

import { Person, Dog } from './models';

export default class Family extends Collection {
  static types = [Person, Dog];

  get dogs() {
    return this.findAll(Dog);
  }

  get germanShepherds() {
    return this.dogs.filter((dog) => dog.breed === 'German Shepherd');
  }

  get minors() {
    return this.findAll(Person).filter((person) => person.age < 18);
  }
}

3. Use your collection

Create new instance

import FamilyCollection from './store/Family';

const family = new FamilyCollection();

Add models

For more ways of adding models, you can check out API Reference and code examples.

import FamilyCollection from './store/Family';
import { Person, Dog } from './store/models';

const family = new FamilyCollection();

const john = family.add(
  {
    name: 'John',
    age: 12,
    id: 1,
  },
  Person,
);

const rex = family.add(
  {
    name: 'Rex',
    breed: 'German Shepherd',
  },
  Dog,
);

const floki = family.add(
  {
    name: 'Floki',
    breed: 'Labrador',
  },
  Dog,
);

console.log(john.greet); // Hey, my name is John and I'm 12.
console.log(rex.greet); // Hey, I am German Shepherd Rex.

Finding models

import FamilyCollection from './store/Family';
import { Person, Dog } from './store/models';

const family = new FamilyCollection();

const john = family.add(
  {
    name: 'John',
    age: 12,
    id: 1,
  },
  Person,
);

const rex = family.add(
  {
    name: 'Rex',
    breed: 'German Shepherd',
  },
  Dog,
);

const floki = family.add(
  {
    name: 'Floki',
    breed: 'Labrador',
  },
  Dog,
);

console.log(family.getAllModels()); // [Person, Dog, Dog]
console.log(family.dogs); // [Dog, Dog]
console.log(family.findOne(Person, 1)); // Person

Deleting models

import FamilyCollection from './store/Family';
import { Person, Dog } from './store/models';

const family = new FamilyCollection();

const john = family.add(
  {
    name: 'John',
    age: 12,
    id: 1,
  },
  Person,
);

const rex = family.add(
  {
    name: 'Rex',
    breed: 'German Shepherd',
  },
  Dog,
);

const floki = family.add(
  {
    name: 'Floki',
    breed: 'Labrador',
  },
  Dog,
);

console.log(family.removeAll(Dog));
console.log(family.dogs); // [];

console.log(family.removeOne(Person, 1));
console.log(family.findAll(Person)); // [];