utils

A set of Tiny utilities Functions to simple use.

Install

Module

npm i @jrnwn/utils

CDN

<script src="https://unpkg.com/@jrnwn/utils"><script>

How to use

Array utils

Module

import {
  range,
} from '@jrnwn/utils'

CDN

const {
  range,
} = Utils

API

function range (start?: number, end?: number, step?: number) => number[]

Cookies utils

Module

import {
  getCookie,
  setCookie,
  deleteCookie,
} from '@jrnwn/utils'

CDN

const {
  getCookie,
  setCookie,
  deleteCookie,
} = Utils

API

function getCookie (name: string) =>  string | undefined

function setCookie (name: string, value: string, expireDays: number) =>  void

function deleteCookie (name: string) =>  void

Date utils

Module

import {
  clonedDate,
  addDaysTo,
  fromToday,
  firstDayOfWeek,
  firstDayOfMonth,
  daysFrom,
  monthDays,
  getWeek,
  getMonth,
} from '@jrnwn/utils'

CDN

const {
  clonedDate,
  addDaysTo,
  fromToday,
  firstDayOfWeek,
  firstDayOfMonth,
  daysFrom,
  monthDays,
  getWeek,
  getMonth,
} = Utils

API

function clonedDate (date: Date) =>  Date

function addDaysTo (date: Date, days?: number) =>  Date

function fromToday (days: number) =>  Date

function firstDayOfWeek (date: Date) =>  Date

function firstDayOfMonth (date: Date) =>  Date

function daysFrom (date: Date, days?: number) =>  Date[]

function monthDays (date: Date) =>  number

function getWeek (date: Date) =>  Date[]

function getMonth (date: Date) =>  Date[]

DOM utils

Module

import {
  typeOf,
  createEl,
  setClass,
  removeClass,
  setStyle,
  getSelector,
  platform,
} from '@jrnwn/utils'

CDN

const {
  typeOf,
  createEl,
  setClass,
  removeClass,
  setStyle,
  getSelector,
  platform,
} = Utils

API

function typeOf (element: any) => any

function createEl (type: string) => HTMLElement

function setClass (element: HTMLElement, className: string) => void[]

function removeClass (element: HTMLElement, className: string) => void[]

function setStyle (element: HTMLElement, object: Object) => any[]

function getSelector (element: HTMLElement) => string

function platform () => ({
  isMobile: boolean,
  isDesktop: boolean,
  isDark: boolean,
  isLight: boolean,
})

Format utils

Module

import {
  normalizeText,
  toSplit,
  toCamel,
  toPascal,
  toSnake,
  toKebab,
  toProperName,
} from '@jrnwn/utils'

CDN

const {
  normalizeText,
  toSplit,
  toCamel,
  toPascal,
  toSnake,
  toKebab,
  toProperName,
} = Utils

API

function normalizeText (text: string) =>  string

function toSplit (text: string) =>  string[]

function toCamel (text: string) =>  string

function toPascal (text: string) =>  string

function toSnake (text: string) =>  string

function toKebab (text: string) =>  string

function toProperName (text: string) =>  string

Geometry utils

Module

import {
  getDistance,
} from '@jrnwn/utils'

CDN

const {
  getDistance,
} = Utils

API

function getDistance (p1: Point, p2: Point) => number

Http utils

Module

import {
  loadText,
  loadJson,
} from '@jrnwn/utils'

CDN

const {
  loadText,
  loadJson,
} = Utils

API

function loadText (path: string) => Promise<string>

function loadJson (path: string) => Promise<any>

Math utils

Module

import {
  clamp,
} from '@jrnwn/utils'

CDN

const {
  clamp,
} = Utils

API

function clamp (value: number, min: number, max: number) => number

Object utils

Module

import {
  getDistance,
} from '@jrnwn/utils'

CDN

const {
  getDistance,
} = Utils

API

function get (path: string, obj?: Window | Object) => any

function set (path: string, object: Object | Window | undefined, value: any) => any

function getListOfPaths (obj?: object) => any

Storage utils

Module

import {
  tinyIDB,
} from '@jrnwn/utils'

CDN

const {
  tinyIDB,
} = Utils

API

function tinyIDB () => ({
  get: (key: string) => Promise<void>,
  set: (key: string, value: any) => Promise<void>,
  remove: (key: string) => Promise<void>,
})