jvar.js's Introduction

jvar.js

npm install jvar --save

Support: Discord Server

This library is primarily documented using JSDoc; examples may not be extensive or include all available features. Proper documentation may be created in the future, but it's not currently a priority.

Importing with jvar

Examples

// Full-destructure importing
const {
    math: { factorial, fibonacci },
    fn: { fuzzy, inspect }
} = require('jvar');

// Full-path importing
const factorial = require('jvar/math/factorial');
const fibonacci = require('jvar/math/fibonacci');
const fuzzy = require('jvar/fn/fuzzy');
const inspect = require('jvar/fn/inspect');

// A mix of the two
const { factorial, fibonacci } = require('jvar/math');
const { fuzzy, inspect } = require('jvar/fn');

// importing class types
const Lex = require('jvar/lex');
const Enum = require('jvar/enum');
const Cherry = require('jvar/cherry');
const BitSet = require('jvar/bitset');
// or
const { Lex, Enum, Cherry, BitSet } = require('jvar');

// ESM is not currently supported. Contact me if you need it and know how it works.

Enum

Example: Color.js

const Enum = require('jvar/enum');
module.exports = new Enum({
    RED: 0xFF0000,
    GREEN: 0x00FF00,
    BLUE: 0x0000FF
});

Usage

const Color = require('./Color');
console.log(Color.RED); // 0xFF0000 :: decimal
console.log(Color.get("BLUE")); // 0x00FF00 :: decimal
console.log(Color.has("PURPLE")); // false
console.log(Color.list()); // ['RED', 'BLUE', 'GREEN']

BitSet

Example Usage

const BitSet = require('./bitset');
const bits1 = new BitSet(0b10101);
const bits2 = new BitSet(0b01011);
// Full example coming soon
// Planned feature: non-mutating methods
bits1.and(bits2).or(0b1111).xor(7);