@octopop/utils

@octopop/utils is a library of utility functions that are used across Flam's web applications.

Installation

To install the package, run:

pnpm i @octopop/utils

Index

Other

• validDomainRegex
• validKeyRegex
• validSlugRegex
• chunk
• deepEqual
• nFormatter

constants

• COUNTRIES

constants animation

• FADE_IN_ANIMATION_SETTINGS
• FRAMER_MOTION_LIST_ITEM_VARIANTS
• STAGGER_CHILD_VARIANTS
• SWIPE_REVEAL_ANIMATION_SETTINGS

css

• cn

datetime

• formatDate
• getDateTimeLocal
• getFirstAndLastDay
• getLastDayOfMonth
• timeAgo

domain

• getDomainWithoutWWW
• getSubdomain

encode

• generateMD5Hash
• nanoid

fetch

• fetchWithTimeout
• fetcher

string_utils

• capitalize
• truncate

urls

• paramsMetadata
• constructURLFromUTMParams
• getParamsFromURL
• getSearchParams
• getUrlFromString
• getUrlWithoutUTMParams
• isValidUrl
• linkConstructor

Other

constvalidDomainRegex

validDomainRegex: RegExp = ...

Regular expression for validating a domain.

constvalidKeyRegex

validKeyRegex: RegExp = ...

Regular expression for validating a key.

constvalidSlugRegex

validSlugRegex: RegExp = ...

Regular expression for validating a slug.

constants

constCOUNTRIES

COUNTRIES: {} = ...

constants animation

constFADE_IN_ANIMATION_SETTINGS

FADE_IN_ANIMATION_SETTINGS: { animate: { opacity: number }; exit: { opacity: number }; initial: { opacity: number }; transition: { duration: number } } = ...

constFRAMER_MOTION_LIST_ITEM_VARIANTS

FRAMER_MOTION_LIST_ITEM_VARIANTS: { hidden: { opacity: number; scale: number }; show: { opacity: number; scale: number; transition: { type: string } } } = ...

constSTAGGER_CHILD_VARIANTS

STAGGER_CHILD_VARIANTS: { hidden: { opacity: number; y: number }; show: { opacity: number; transition: { duration: number; type: string }; y: number } } = ...

constSWIPE_REVEAL_ANIMATION_SETTINGS

SWIPE_REVEAL_ANIMATION_SETTINGS: { animate: { height: string }; exit: { height: number }; initial: { height: number }; transition: { duration: number; ease: string } } = ...

urls

constparamsMetadata

paramsMetadata: { display: string; examples: string; key: string }[] = ...

Metadata describing common URL parameters for tracking and analytics.

@example

paramsMetadata.forEach(param => console.log(param.display));