🧺 lota-js

All code is vanilla JS, library agnostic and consist mostly of helper methods that aren't directly related with the DOM, the purpose of this library is to provide modular solutions for common JS problems in kraftvaerk.

Main goals

• increase code reuse;
• be easy to debug;
• be easy to maintain;
• follow best practices;
• be compatible with other frameworks;
• be modular;

Installation

npm i @kraftvaerk/lota-js --save

Contents

Browser

• cookie
• Local storage
• Session storage

Enviorment

Exception

Utilities

• Function
  • debounce
  • throttle
• Object
  • clone
  • extend
  • formToObject
  • parameterize
  • parameterizeUrl
  • urlParams
  • urlHashParams
• Random
  • choice
  • guid
  • hex
  • int
  • number
• String
  • interpolate
  • trim

Another Lodash?

No. The goal is to provide frontend developers in Kraftvaerk with a number of useful and small JavaScript codes, not just functions, but also modules and classes. Think of it as a mini version of npm suitable for tiny packages.

What shouldn't be here

• UI components;
• CSS selector engine;
• Event system - pub/sub;
• Template engine;
• Anything that isn't generic enough;
• Anything that could be a separate library and/or isn't a modular utility...

Submitting New Modules

Unable to find one suitable? Fork it on GitHub, add the module and submit a pull request.

⬆ Back to top

Debounce

This Creates a function that will delay the execution of fn until after delay milliseconds have elapsed since the last time it was invoked. Subsequent calls to the debounced function will return the result of the last fn call.

debounce(fn, delay[, isAsap]):Function

Examples

const lazyRedraw = debounce(redraw, 300);

foo.on.resize.add(lazyRedraw);

//lazyRedraw won't be called since `cancel` was called before the `delay`
lazyRedraw.cancel();

Throttle

Creates a function that, when executed, will only call the fn function at most once per every interval milliseconds.

If the throttled function is invoked more than once during the wait timeout, fn will also be called on the trailing edge of the timeout. Subsequent calls to the throttled function will return the result of the last fn call.

throttle(fn, interval):Function

Examples

const lazyRedraw = throttle(redraw, 300);
foo.on.resize.add(lazyRedraw);
lazyRedraw();
setTimeout(function(){
    lazyRedraw();
    
    // lazyRedraw will be called only once since 'cancel' was called before the 'interval' for 2nd call completed
    lazyRedraw.cancel();
}, 250);

Choice

Returns a random element from the supplied arguments or from the array (if single argument is an array).

choice(...items):*

Examples

choice(1, 2, 3, 4, 5); // 3

choice(['lorem', 'ipsum', 'dolor']); // 'dolor'

Guid

Generates a pseudo-random Globally Unique Identifier Since the total number of GUIDs is 2^122 the chance of generating the same value twice is negligible.

Important: this method uses Math.random by default so the UUID isn't safe (sequence of outputs can be predicted in some cases),

Returns pseudo-random guid (UUID v4) IMPORTANT: it's not totally "safe" since randomHex/choice uses Math.random by default and sequences can be predicted in some cases.

guid():String

Examples

guid(); // 807a16ee-0258-4342-a34c-3d3638a27876

Hex

Returns a random hexadecimal string with the default length of 6

randomHex([size=6]):String

Examples

randomHex();   // "dd8575"
randomHex(30); // "effd7e2ad9a4a3067e30525fab983a"

RandomInt

Returns a random integer inside range or snap to min/max values.

randInt([min], [max]):Number

Examples

randomInt();      // 448740433
randomInt();      // -31797596
randomInt(0, 10); // 7
randomInt(0, 10); // 5

RandomNumber

Returns a random number inside range or snap to min/max values

randomNumber([min], [max]):Number

Examples

randomNumber();      // 448740433.55274725
randomNumber();      // -31797596.097682
randomNumber(0, 10); // 7.369723
randomNumber(0, 10); // 5.987042

Interpolate

String interpolation. Format/replace tokens with object properties.

interpolate(str, replacements[, syntax]):String

Examples

const tmpl = 'Hello {{name}}!';
interpolate(tmpl, {name: 'World'});       // "Hello World!"

const tmpl = 'Hello {{name.first}}!';
interpolate(tmpl, {name: {first: 'Lorem'}}); // "Hello Lorem!"

// matches everything inside "${}"
const syntax = /\$\{([^}]+)\}/g;
const tmpl = "Hello ${0}!";
interpolate(tmpl, ['Foo Bar'], syntax); // "Hello Foo Bar!"

Trim

Remove chars or white-spaces from beginning and end of string. chars is an array of chars to remove from the beginning and end of the string. If chars is not specified, Unicode whitespace chars will be used instead.

trim(str, [chars]):String

Examples

trim('   lorem ipsum   ');             // "lorem ipsum"
trim('-+-lorem ipsum-+-', ['-', '+']); // "lorem ipsum"

rTrim

Remove chars or white-spaces from end of string. chars is an array of chars to remove from the end of the string. If chars is not specified, Unicode whitespace chars will be used instead.

rtrim(str, [chars]):String

Examples

rtrim('   lorem ipsum   ');      // "   lorem ipsum"
rtrim('--lorem ipsum--', ['-']); // "--lorem ipsum"

lTrim

Remove chars or white-spaces from beginning of string. chars is an array of chars to remove from the beginning of the string. If chars is not specified, Unicode whitespace chars will be used instead.

ltrim(str, [chars]):String

Examples

ltrim('   lorem ipsum   ');      // "lorem ipsum   "
ltrim('--lorem ipsum--', ['-']); // "lorem ipsum--"

License

MIT © Kraftvaerk