Spices - Basil

A JavaScript utility library for common tasks with a plugin system.

Motivations

• To have a go to for simple tasks without the over-weight of a lodash like package.
• To allow a plugin system to extends that logic for extensibility but more on demand.

How does it works?

Install by default

By default @spices is build for VueJS but it is an option for basil.

import { basil } from '@spices/basil'

let n = basil.random(1, 8); // yield a number between 1 - 8

Install for VueJS

Installing @spices/basil for VueJS will give you some more feature:

• Declare the $basil property to the Vue prototype that allows you to use all the utilities from the components.
• Declare some mixins to easily transform your data from the components.

import Vue from 'vue'
import { basil, install } from '@spices/basil`

Vue.use(install)

API

basil.debounce(fn:Function, [wait:Number=0], [options:Object={}]):Function`

Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout. The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last func invocation.

Arguments

fn (Function): The function to debounce. [wait=0] : The number of milliseconds to delay. [options={}]