easeyourhunt-shared

Ease Your Hunt Shared

Shared interfaces and type definitions for Ease Your Hunt applications.

Installation

npm install easeyourhunt-shared
# or
yarn add easeyourhunt-shared

Usage

Import Options

You can import from specific paths for better code organization and tree-shaking. Both import patterns are supported:

// Pattern 1: Short paths (recommended)
import { IResume, IWorkExperience, CategoryTypeDataMap, IUser } from 'easeyourhunt-shared/types';
import { DEFAULT_RESUME, DEFAULT_WORK_EXPERIENCE, DEFAULT_USER } from 'easeyourhunt-shared/defaults';
import { CategoryType } from 'easeyourhunt-shared/enums';

// Pattern 2: Direct dist paths (for specific module resolution settings)
import { IUser, IUserCreate } from 'easeyourhunt-shared/dist/interfaces/user.interfaces';
import { IResume } from 'easeyourhunt-shared/dist/interfaces/resume.interfaces';
import { DEFAULT_USER } from 'easeyourhunt-shared/dist/defaults/user.defaults';
import { CategoryType } from 'easeyourhunt-shared/dist/enums/categories.enum';

// Or import everything (not recommended for production)
import { IResume, DEFAULT_RESUME, CategoryType, CategoryTypeDataMap, IUser } from 'easeyourhunt-shared';

For frontend applications

In frontend applications, these interfaces can be used for type checking API responses and for form validation schemas.

For backend applications

In backend applications, you can implement these interfaces in your DTOs and entities to ensure consistency.

Available Exports

Types (easeyourhunt-shared/types or direct imports)

• IBasics - Basic user information
• IWorkExperience - Work experience information
• IEducation - Education information
• ISkill - Skills information
• ILanguage - Languages information
• IProject - Projects information
• IResume - Complete resume structure
• CategoryTypeDataMap - Type mapping between CategoryType enum and corresponding data types
• IUser - User account information
• IUserCreate - User creation data
• IUserAuth - User authentication data
• IUserUpdate - User update data

Defaults (easeyourhunt-shared/defaults or direct imports)

• DEFAULT_BASICS - Default values for basic information
• DEFAULT_WORK_EXPERIENCE - Default values for work experience
• DEFAULT_EDUCATION - Default values for education
• DEFAULT_SKILL - Default values for skills
• DEFAULT_LANGUAGE - Default values for languages
• DEFAULT_PROJECT - Default values for projects
• DEFAULT_RESUME - Default values for a complete resume
• DEFAULT_USER - Default values for user information
• DEFAULT_USER_CREATE - Default values for user creation
• DEFAULT_USER_UPDATE - Default values for user updates

Enums (easeyourhunt-shared/enums or direct imports)

• CategoryType - Enum for resume categories (BASICS, WORK, etc.)

License

ISC