3.3.1 • Published 3 years ago

@codler/utils v3.3.1

Weekly downloads
-
License
ISC
Repository
github
Last release
3 years ago

@codler/utils

Install

npm i @codler/utils

Reference

adBlock

import { adBlock } from "@codler/utils";
await adBlock.checkIsEnabled();
adBlock.isEnabled();
MethodNotes
checkIsEnabledPromise<boolean>
isEnabledboolean

color

import { color } from "@codler/utils";
color.linear(value, maxValue);
color.scaled(value, maxValue);
MethodNotes
linear(value: number, maxValue: number): hexColor
scaled(value: number, maxValue: number): hexColor

date

import { date } from "@codler/utils";
date.format(new Date()); // 2020-01-01
date.today; // 2020-01-01
date.yesterday; // 2020-01-01
date.oneWeekAgo; // 2020-01-01
date.oneMonthAgo; // 2020-01-01
date.getWeek(new Date()); // { year: 2020, week: 1 }
date.getMondayFromWeek({ year: 2020, week: 1 }); // Date object
date.getSundayFromWeek({ year: 2020, week: 1 }); // Date object
MethodNotes
format(date: Date) => YYYY-MM-DD
todayYYYY-MM-DD
yesterdayYYYY-MM-DD
oneWeekAgoYYYY-MM-DD
oneMonthAgoYYYY-MM-DD
getWeek(date: Date): { year: number; week: number }
getMondayFromWeek({ year: number; week: number }): Date
getSundayFromWeek({ year: number; week: number }): Date

debounce

import { debounce } from "@codler/utils";
debounce(() => void, 100);
ParameterNotes
funcfunction
waitnumber

platform

import { platform } from "@codler/utils";
platform.isIos();
platform.isAndroid();
MethodNotes
isIosboolean
isAndroidboolean

scrollToElement

import { scrollTo, scrollToElement, easing } from "@codler/utils";
// ...
MethodNotes
scrollTo(targetPosition: number, scrollDistance: number, duration: number, easing: Function)
scrollToElement(node: HTMLElement, duration: number, easing: Function)
easing{easeInQuad}

React Hooks

useAsyncStorage

import { useAsyncStorage } from "@codler/utils";
const [get, set, isInit] = useAsyncStorage < T > (key, initialValue);
VariableNotes
getT
setfunction
isInitboolean

useInViewport

import { useInViewport } from "@codler/utils";
const { isVisible, update } = useInViewport();
VariableNotes
isVisibleboolean
updatefunction

useLocalStorage

import { useLocalStorage } from "@codler/utils";
const [get, set] = useLocalStorage < T > (key, initialValue);
VariableNotes
getT
setfunction

useWindowSize

import { useWindowSize } from "@codler/utils";
const { width, height } = useWindowSize();
VariableNotes
widthnumber
heightnumber

Maintainer

Han Lin Yap

3.3.1

3 years ago

3.2.0

3 years ago

3.1.0

3 years ago

3.0.0

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.1.0

4 years ago

1.0.0

4 years ago