freelanceflow-shared
v1.1.0
Published
Shares enums and utilities for the FreelanceFlow project.
Downloads
12
Readme
freelanceflow-shared
freelanceflow-shared
is a package designed to share enums and utilities for the FreelanceFlow project. This package includes enums related to project management, offer statuses, and states in Brazil.
Installation
You can install the package via npm:
npm install freelanceflow-shared
Usage
Enums
This package exports several enums for use in your project:
OfferStatusEnum
Represents the various statuses an offer can have.
import OfferStatusEnum from 'freelanceflow-shared/lib/enums/OfferStatusEnum';
// Get all offer statuses
const allStatuses = OfferStatusEnum.getAllOfferStatus();
// Get an offer status by ID
const statusById = OfferStatusEnum.getOfferStatusById(1);
// Get an offer status by value
const statusByValue = OfferStatusEnum.getOfferStatusByValue('open');
ProjectAreaEnum
Represents different areas of a project.
import ProjectAreaEnum from 'freelanceflow-shared/lib/enums/ProjectAreaEnum';
// Get all project areas
const allAreas = ProjectAreaEnum.getAllProjectAreas();
// Get a project area by ID
const areaById = ProjectAreaEnum.getProjectAreaById(1);
// Get a project area by value
const areaByValue = ProjectAreaEnum.getProjectAreaByValue('data-science');
ProjectStatusEnum
Represents the various statuses a project can have.
import ProjectStatusEnum from 'freelanceflow-shared/lib/enums/ProjectStatusEnum';
// Get all project statuses
const allStatuses = ProjectStatusEnum.getAllProjectStatus();
// Get a project status by ID
const statusById = ProjectStatusEnum.getProjectStatusById(1);
// Get a project status by value
const statusByValue = ProjectStatusEnum.getProjectStatusByValue('open');
StatesEnum
Represents Brazilian states.
import StatesEnum from 'freelanceflow-shared/lib/enums/StateEnum';
// Get all states
const allStates = StatesEnum.getAllStates();
// Get a state by ID
const stateById = StatesEnum.getStateById(1);
// Get a state by code
const stateByCode = StatesEnum.getStateByCode('AC');
Documentação
OfferStatusEnum
static getAllOfferStatus()
: Recupera uma lista de todos os status de oferta.static getOfferStatusById(id)
: Recupera um status de oferta específico pelo seu ID.static getOfferStatusByValue(value)
: Recupera um status de oferta específico pelo seu valor.
ProjectAreaEnum
static getAllProjectAreas()
: Recupera uma lista de todas as áreas de projeto.static getProjectAreaById(id)
: Recupera uma área de projeto específica pelo seu ID.static getProjectAreaByValue(value)
: Recupera uma área de projeto específica pelo seu valor.
ProjectStatusEnum
static getAllProjectStatus()
: Recupera uma lista de todos os status de projeto.static getProjectStatusById(id)
: Recupera um status de projeto específico pelo seu ID.static getProjectStatusByValue(value)
: Recupera um status de projeto específico pelo seu valor.
StatesEnum
static getAllStates()
: Recupera uma lista de todos os estados.static getStateById(id)
: Recupera um estado específico pelo seu ID.static getStateByCode(code)
: Recupera um estado específico pelo seu código.