js-expansion

Javascript Expansion

Package to expand default Javascript types like, Array, Number and String

Install

npm install --save js-expansion

Usage

require('js-expansion')

/* Nested Array */
const collection = [
    {
        id: 1,
        name: 'Piet'
    },
    {
        id: 2,
        name: 'henry',
        friends: [
            {
                id: 3,
                name: 'Karel',
            }   
        ]
    },
]

// Get first element from Array
const firstElement = collection.first()

// Get last element from Array
const lastElement = collection.last()

// Search objects in array on key => value
const foundElement = collection.findBy('name', 'henry')

// Search object index in array on key => value
const indexElement = collection.findIndexBy('name', 'henry')

// Get value from array by dot notation: Karel
const friend_name = collection.get('1.friends.0.name')

// Sort array by object key (direction desc)
const sortedCollection = collection.sortBy('id', 'desc')

// default direction asc
const sortedCollection = collection.sortBy('id') 

// Delete element from array
const deleteCollection = collection.delete(2)

// Delete element from array with objects
const deleteCollection = collection.delete(2, 'id')

// Add new element to the Array if the value is already present in the collection is does not adds it again.
const addCollection = collection.save(1)

// Add new element to the Array with objects
const addCollection = collection.save({
    id: 3,
    name: 'klaas'
})

// Update existing element in the array (default updates on key `id`)
const updateCollection = collection.save({
    id: 1,
    name: 'klaas'
})

// Update existing element in the array by custom key
const updateCollection = collection.save({
    name: 'klaas',
    age: 10
}, 'name')


/* Normal Array methods */
const array = ['piet', 'henry']

// Search Array
const searchResult = array.search('piet')

// Clone Array
const clonedArray = array.clone()

/* String methods */
const string = 'piet'

// Capitalize string
const capitalized = string.ucfirst()

/* Number methods */ 
const seconds = 60

// Convert seconds to time: 00:00
seconds.time()

const price = 10.50

// Convert number/float price into label: € 10,50
price.price('EUR', 'nl-NL')

Helpers

require('js-expansion')
const {query, form, request} = require('js-expansion')

// Convert object to FormData (for multipart/form-data)
const formData = form({
    title: 'henry',
    thumbnail: File,
    permissions: [1, 2, 3]
})


// Create GET params url from object: ?search=piet&paginate=10
const queryUrl = query({search: 'piet', paginate: 10})

// Create request from params: /users/1?details=true
// replaces variables from url with params, and adds (only when type is 'get') the remaining params to the query url using the query method.
// available types: ('get', 'post', 'put', 'delete')
const requestUrl = request('get', '/users/{id}', {id: 1, details: true})

Tests

cd example
yarn install
yarn start

License

MIT © tychovbh