🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more
Sign In

entity-class

Package Overview
Dependencies
Maintainers
1
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

entity-class

Base class for all your entities

latest
npmnpm
Version
1.0.3
Version published
Maintainers
1
Created
Source

Entity class

npm Snyk Vulnerabilities for GitHub Repo GitHub Workflow Status

Base class for all your entities

import Entity from 'entity-class';

const entity = new Entity({
  name: 'John',
  last_name: 'Carpenter'
});

console.log(entity.get('name')); // returns name

Made to be extended

import Entity from 'entity-class';

interface IUser {
 name: string;
 age: number;
 last_name: string;
}

class User extends Entity<IUser> {
 getName() {
   return this.get('name');
 }

 getLastName() {
   return this.get('last_name');
 }

 getAge() {
   return this.get('age');
 }

 getFullName() {
   return `${this.getName()} ${this.getLastName()}`;
 }

 isAdult() {
   return this.getAge() > 21;
 }
}

const user = new User({
  name: 'John',
  age: 12,
  last_name: 'Carpenter'
});

console.log(user.getFullName()): // returns full name of user

Full support for typescript

 import Entity from 'entity-class';

 interface IUser {
   name: string;
   last_name: string;
   age?: number;
 }

 class User extends Entity<IUser> {
   getName() {
     return this.get('name');
   }

   getLastName() {  // : string
     return this.get('last_name');
   }

   getAge() {  // : number | undefined
     return this.get('age');
   }

   getFullName() {
     return `${this.getName()} ${this.getLastName()}`;
   }
 }

 const user = new User({
   name: 'John',
 });

 // Will indicate error:
 // Argument of type '{ name: string; }' is not assignable to parameter of type 'IUser'.
 // Property 'last_name' is missing in type '{ name: string; }' but required in type 'IUser'

Keywords

class

FAQs

Package last updated on 12 Sep 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts