npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

voucher-validator

v1.1.2

Published

This lib provide validator to check business rules for a voucher

Downloads

16

Readme

Voucher Validator

This lib validate vouchers.


Installation


$ npm install voucher-validator

# OR 

$ yarn add voucher-validator

How to use

user document pattern:

  • 372.061.670-39 or
  • 37206167039

import { Validator } from 'voucher-validator';

const validator = new Validator();

const isValid = validator.Validate({
	userDocument: '372.061.670-39', 
	product: 'MY_PRODUCT',
	voucher: myVoucher
});

console.log(isValid);

> true

Get total to pay with discount


import { Validator } from 'voucher-validator';

const validator = new Validator();

const total = 1000;

const totalToPay = validator.CalculateTotalWithDiscount(total, voucher10);

console.log(totalToPay);

> 900

Get total of discount


import { Validator } from 'voucher-validator';

const validator = new Validator();

const total = 1000;

const totalDiscount = validator.GetDiscount(total, voucher10);

console.log(totalDiscount);

> 100

OR another option to validate voucher


import { VoucherValidator } from 'voucher-validator';

const validator = new VoucherValidator({ 
	userDocument: '372.061.670-39', 
	product: 'MY_PRODUCT' 
});

const isValid = validator.isSatisfiedBy(myVoucher);

console.log(isValid);

> true

Validations

  • IsUsedVoucher
  • IsOnRangeDate start date less than current and end date greater then current
  • IsNominal and UserDocument Match
  • IsValidProduct
  • IsVoucherDeleted

Types

Voucher types


export interface Voucher {     
	codigoVoucher: string;
	dataUtilizacao: Date;
	idLote: string;
	documentoVinculado: null | string;
	valido: boolean;
	idCliente: number;
	idConvenio: number;
	utilizado: boolean;
	tipoCupom: 'GENERICO' | 'NOMINAL' | 'NAO NOMINAL';
	login: string;
	dataInicioValidade: Date;
	dataFimValidade: Date;
	quantidadeDesconto: number;
	createdAt: Date;
	deletedAt: Date | null;
	produto: string;
	id_produto: string;
}