Web Utils 🛠️

Common TypeScript web utilities

Getting started

Run the following command to start using web-utils in your projects:

npm i @alessiofrittoli/web-utils

or using pnpm

pnpm i @alessiofrittoli/web-utils

API Reference

Blob utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/blob'

`downloadBlob`

Create and download a blob object.

Parameters

Parameter	Type	Description
`filename`	`string`	The download file name.
`data`	`BodyInit`	The download file data.
`init`	`ResponseInit`	(Optional) The ResponseInit object.

Usage

Download file from HTTP Response

fetch( ... )
  .then( response => response.formData() )
  .then( async data => {
    await Promise.all(
      Array.from( data.entries() )
        .map( async ( [, file ] ) => {
          if ( ! ( file instanceof File ) ) return
          await downloadBlob( file.name, file )
        } )
    )
  } )
  .catch( error => {
    console.error( error )
  } )

Generators utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/generators'

`isGeneratorFunction`

Check if a function is a GeneratorFunction or AsyncGeneratorFunction.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The function to check.

Returns

Type: reference is GeneratorFunction | AsyncGeneratorFunction

true if the given reference is a GeneratorFunction or AsyncGeneratorFunction.
false otherwise.

`isDefaultGeneratorFunction`

Check if a function is a GeneratorFunction.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The function to check.

Returns

Type: reference is GeneratorFunction

true if the given reference is a GeneratorFunction.
false otherwise.

`isAsyncGeneratorFunction`

Check if a function is an AsyncGeneratorFunction.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The function to check.

Returns

Type: reference is AsyncGeneratorFunction

true if the given reference is an AsyncGeneratorFunction.
false otherwise.

`isGeneratorObject<T>`

Check if reference is a Generator or AsyncGenerator.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The reference to check.

Returns

Type: reference is Generator<T> | AsyncGenerator<T>

true if the given reference is a Generator or AsyncGenerator.
false otherwise.

`isDefaultGeneratorObject<T>`

Check if reference is a Generator.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The reference to check.

Returns

Type: reference is Generator<T>

true if the given reference is a Generator.
false otherwise.

`isAsyncGeneratorObject<T>`

Check if reference is an AsyncGenerator.

Parameters

Parameter	Type	Description
`reference`	`unknown`	The reference to check.

Returns

Type: reference is AsyncGenerator<T>

true if the given reference is an AsyncGenerator.
false otherwise.

Map utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/map'

Interface `TypedMap<T, P, K>`

A type-safe extension of the Map class that enforces key-value relationships based on a provided type.

Type parameters

Parameter	Type	Default	Description
`T`	`Record<string, unknown>`	`unknown`	The object type defining the key-value relationships.
`P`	`boolean`	`true`	Defines whether the `Map.get()` method should return a possibily `undefined` value.
`K`	`keyof T`	`keyof T`	Internal - The subset of keys in T that are allowed in the Map.

`getTypedMap<T, P, K>`

Creates a new instance of a type-safe Map with the given type.

Type parameters

See Interface TypedMap<T, P, K> - Type parameters

Parameters

Parameter	Type	Description
`iterable`	`Iterable<readonly [ K, T[ K ] ]> \| null`	Initial `Map` constructor iterable object.

Returns

Type: TypedMap<T, P, K>

A new instance of a type-safe Map.

Usage

Basic usage

interface User
{
  name      : string
  age       : number
  isActive  : boolean
}

const user = getTypedMap<User>( [
  [ 'name',     'Foo' ],
  [ 'age',      27 ],
  [ 'isActive', true ],
] )

console.log( user.get( 'name' ) ) // type: `string | undefined`
console.log( user.get( 'age' ) ) // type: `number | undefined`
console.log( user.get( 'isActive' ) ) // type: `boolean | undefined`

Respect the given type

interface User
{
  name      : string
  age       : number
  isActive  : boolean
  banned?   : boolean
}

const user = getTypedMap<User, false>( [
  [ 'name',     'Foo' ],
  [ 'age',      27 ],
  [ 'isActive', true ],
] )

console.log( user.get( 'name' ) ) // type: `string`
console.log( user.get( 'age' ) ) // type: `number`
console.log( user.get( 'isActive' ) ) // type: `boolean`
console.log( user.get( 'banned' ) ) // type: `boolean | undefined`

Promises utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/promises'

`sleep`

Await a void Promise that resolves after the given time.

Parameters

Parameter	Type	Description
`time`	`number`	The sleep time in milliseconds after the Promise get resolved.

Returns

Type: Promise<void>

A new Promise which get resolved after the specified time.

Usage

const fn = async () => {
  // ...
  await sleep( 2000 )
  // ...
}

Strings utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/strings'

`ucFirst`

Make first letter uppercase.

Parameters

Parameter	Type	Description
`input`	`string`	The input string to convert.

Returns

Type: string

The processed string.

Usage

console.log( ucFirst( 'String value' ) ) // Outputs: 'String value'
console.log( ucFirst( 'string value' ) ) // Outputs: 'String value'

`lcFirst`

Make first letter lowercase.

Parameters

Parameter	Type	Description
`input`	`string`	The input string to convert.

Returns

Type: string

The processed string.

Usage

console.log( lcFirst( 'String value' ) ) // Outputs: 'string value'
console.log( lcFirst( 'string value' ) ) // Outputs: 'string value'

`toCamelCase`

Convert string to camelCase.

Parameters

Parameter	Type	Description
`input`	`string`	The input string to convert.

Returns

Type: string

The converted string to camelCase.

Usage

console.log( toCamelCase( 'font-family' ) ) // Outputs: 'fontFamily'
console.log( toCamelCase( 'background-color' ) ) // Outputs: 'backgroundColor'
console.log( toCamelCase( '-webkit-align-content' ) ) // Outputs: 'WebkitAlignContent'
console.log( toCamelCase( 'some value' ) ) // Outputs: 'someValue'
console.log( toCamelCase( 'some_value' ) ) // Outputs: 'someValue'
console.log( toCamelCase( 'some value_with mixed_Cases' ) ) // Outputs: 'someValueWithMixedCases'
console.log( toCamelCase( '-string@with#special$characters' ) ) // Outputs: 'StringWithSpecialCharacters'

`toKebabCase`

Convert string to kebab-case string.

Parameters

Parameter	Type	Description
`input`	`string`	The input string to convert.

Returns

Type: string

The converted string to kebab-case.

Usage

console.log( toKebabCase( 'fontFamily' ) ) // Outputs: 'font-family'
console.log( toKebabCase( 'backgroundColor' ) ) // Outputs: 'background-color'
console.log( toKebabCase( 'string with spaces' ) ) // Outputs: 'string-with-spaces'
console.log( toKebabCase( 'string_with_underscores' ) ) // Outputs: 'string-with-underscores'
console.log( toKebabCase( 'WebkitAlignContent' ) ) // Outputs: '-webkit-align-content'
console.log( toKebabCase( 'some value_with mixed_Cases' ) ) // Outputs: 'some-value-with-mixed-cases'
console.log( toKebabCase( '-string@with#special$characters' ) ) // Outputs: '-string-with-special-characters

`stringifyValue`

Stringify value.

Parameters

Parameter	Type	Description
`input`	`any`	The value to stringify.

Returns

Type: string

The stringified input.

Usage

console.log( stringifyValue( new Date( 'Sat, 20 Apr 2025 16:20:00 GMT' ) ) )
// Outputs: '2025-04-20T16:20:00.000Z'

console.log( stringifyValue( null ) )
// Outputs: 'null'

console.log( stringifyValue( { prop: 'value', prop2: true } ) )
// Outputs: '{"prop":"value","prop2":true}'

console.log( stringifyValue( [ 1, 2, true, null, () => {} ] ) )
// Outputs: '[1,2,true,null,null]'

console.log( stringifyValue(
  new Map( [
    [ 'key', 'value' ],
    [ 'key2', 'value' ],
  ] )
) )
// Outputs: '[["key","value"],["key2","value"]]'

console.log( stringifyValue(
  new Headers( {
    key   : 'value',
    key2  : 'value',
  } )
) )
// Outputs: '[["key","value"],["key2","value"]]'

console.log( stringifyValue( true ) ) // Outputs: 'true'
console.log( stringifyValue( false ) ) // Outputs: 'false'
console.log( stringifyValue( 0 ) ) // Outputs: '0'
console.log( stringifyValue( 420 ) ) // Outputs: '420'

console.log( stringifyValue( undefined ) ) // Outputs: ''
console.log( stringifyValue( () => {} ) ) // Outputs: ''
console.log( stringifyValue( new Promise<void>( resolve => resolve() ) ) ) // Outputs: ''

`parseValue`

Parse stringified value.

Type parameters

Parameter	Description
`T`	The expected returned value type.

Parameters

Parameter	Type	Description
`input`	`string`	The value to parse.

Returns

Type: T | undefined

The parsed input.
undefined if no input or empty string is given.

Usage

console.log( parseValue<Date>( stringifyValue( new Date() ) ) )
// Outputs: current Date object.

console.log( parseValue<number>( '12345' ) ) // Outputs: 12345
console.log( parseValue() ) // Outputs: undefined
console.log( parseValue( ' ' ) ) // Outputs: undefined

console.log( parseValue<true>( stringifyValue( true ) ) )
// Outputs: true

console.log( parseValue( stringifyValue( { key: 'value' } ) ) )
// Outputs: { key: 'value' }

console.log( parseValue( stringifyValue( [ 1, 2, 3, 4, 5 ] ) ) )
// Outputs: [ 1, 2, 3, 4, 5 ]

console.log( parseValue( 'String value' ) ) // Outputs: 'String value'

Types utilities

⚠️ Docs coming soon

Validation utilities

⚠️ Docs coming soon

Browser API utilities

Importing the utilitites

import { ... } from '@alessiofrittoli/web-utils'
// or
import { ... } from '@alessiofrittoli/web-utils/browser-api'

`openBrowserPopUp`

Opens a webpage in a browser PopUp.

The openBrowserPopUp uses Window.open() under the hood, but provides default options to make your work easier.

Parameters

Parameter	Type	Default	Description
`options`	`OpenBrowserPopUpOptions`	-	An object defining custom PopUp options.
`options.url`	`UrlInput`	-	The URL or path of the resource to be loaded. See UrlInput for more info about accepted formats.
`options.width`	`number`	`600`	The PopUp width.
`options.height`	`number`	`800`	The PopUp height.
`options.context`	`string`	-	A string, without whitespace, specifying the name of the browsing context the resource is being loaded into.
`options.features`	`OptionsFeatures`	-	Additional custom PopUp features.

Returns

Type: WindowProxy | null

a WindowProxy object is returned if the browser successfully opens the new browsing context.
null is returned if the browser fails to open the new browsing context, for example because it was blocked by a browser popup blocker.

Usage

Re-focus a previously opened popup

let windowProxy: WindowProxy | null = null

const clickHandler = () => {
  if ( windowProxy && ! windowProxy.closed ) {
    return windowProxy.focus()
  }

  windowProxy = openBrowserPopUp( {
    url     : {
      pathname  : '/',
      query     : { key: 'value' }
    },
  } )
}

Re-use a popup

const clickHandler = () => {
  openBrowserPopUp( {
    context : 'some-context-name',
    url     : {
      pathname  : '/',
      query     : { key: 'value' }
    },
  } )
}


const clickHandler2 = () => {
  openBrowserPopUp( {
    context : 'some-context-name',
    url     : '/other-path',
  } )
}

Storage utilities

`Cookie` Class

Importing the class

import { Cookie } from '@alessiofrittoli/web-utils'
// or
import { Cookie } from '@alessiofrittoli/web-utils/storage/Cookie'

Importing enum and types

import { Priority, SameSite } from '@alessiofrittoli/web-utils'
// or
import { Priority, SameSite } from '@alessiofrittoli/web-utils/storage/Cookie'

import type { RawCookie, ParsedCookie, ParsedCookieMap } from '@alessiofrittoli/web-utils'
// or
import type { RawCookie, ParsedCookie, ParsedCookieMap } from '@alessiofrittoli/web-utils/storage/Cookie'

Enumerators

`Priority` Enum

The Cookie Priority.

Constant	Value	Description
`Low`	Low	Low priority.
`Medium`	Medium	Medium priority (default).
`High`	High	High priority.

`SameSite` Enum

Controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).

Constant	Value	Description
`Strict`	Strict	The browser sends the cookie only for same-site requests.
`Lax`	Lax	The cookie is not sent on cross-site requests, such as on requests to load images or frames, but is sent when a user is navigating to the origin site from an external site.
`None`	None	The browser sends the cookie with both cross-site and same-site requests.

Types

`RawCookie<K, V>`

Interface representing Cookie properties before it get parsed.

Properties

Property	Type	Description
`name`	`K`	The Cookie name.
`value`	`V`	The Cookie value.
`domain`	`string`	Defines the host to which the cookie will be sent.
`expires`	`string \| number \| Date`	Indicates the maximum lifetime of the cookie.
`httpOnly`	`boolean`	Forbids JavaScript from accessing the cookie, for example, through the `Document.cookie` property.
`maxAge`	`number`	Indicates the number of seconds until the cookie expires. If set, `expires` is ignored.
`partitioned`	`boolean`	Indicates that the cookie should be stored using partitioned storage.
`path`	`string`	Indicates the path that must exist in the requested URL for the browser to send the `Cookie` header.
`sameSite`	`SameSite`	Controls whether or not a cookie is sent with cross-site requests, providing some protection against cross-site request forgery attacks (CSRF).
`secure`	`boolean`	Indicates that the cookie is sent to the server only when a request is made with the https: scheme.
`priority`	`Priority`	Defines the Cookie priority.

`ParsedCookie<K, V>`

Interface representing Cookie properties after it get parsed.

Properties

Extends and overrides - RawCookie<K, V>

Property	Type	Description
`expires`	`Date`	Indicates the maximum lifetime of the cookie.

`ParsedCookieMap<K, V>`

Map representation of a parsed Cookie.

Static methods

`Cookie.parse<K, V>()`

Parse the given cookie parameters to a Cookie Map.

Type parameters

Parameter	Description
`K`	The typed cookie name.
`V`	The type of the cookie value.

Parameters

Parameter	Type	Description
`options`	`RawCookie<K, V> \| ParsedCookieMap<K, V>`	The cookie options or a parsed Cookie Map.

Returns

Type: ParsedCookieMap<K, V>

The parsed Cookie Map.

Usage

const cookie = Cookie.parse( {
  name        : 'cookiename',
  value       : { test: 'value' },
  path        : '/specific-path',
  priority    : Priority.High,
  expires     : Date.now() + 20 * 60 * 1000,
  domain      : 'example.com',
  secure      : true,
  httpOnly    : true,
  sameSite    : SameSite.Lax,
  maxAge      : Date.now() + 30 * 60 * 1000,
  partitioned : true,
} )

`Cookie.toString<K, V>()`

Stringify a Cookie ready to be stored.

Type parameters

Parameter	Description
`K`	The typed cookie name.
`V`	The type of the cookie value.

Parameters

Parameter	Type	Description
`options`	`RawCookie<K, V> \| ParsedCookieMap<K, V>`	The cookie options or a parsed Cookie Map.

Returns

Type: string

The stringified Cookie ready to be stored.

Usage

document.cookie = (
  Cookie.toString( {
    name        : 'cookiename',
    value       : { test: 'value' },
    path        : '/specific-path',
    priority    : Priority.High,
    expires     : Date.now() + 20 * 60 * 1000,
    domain      : 'example.com',
    secure      : true,
    httpOnly    : false,
    sameSite    : SameSite.Lax,
    maxAge      : Date.now() + 30 * 60 * 1000,
    partitioned : true,
  } )
)

`Cookie.fromString<K, V>()`

Parse a cookie string to a Cookie Map.

Type parameters

Parameter	Description
`K`	The typed cookie name.
`V`	The expected cookie value type.

Parameters

Parameter	Type	Description
`cookie`	`string`	The cookie string.

Returns

Type: ParsedCookieMap<K, V> | null

The parsed Cookie Map or null if parsing fails.

Usage

const cookies = (
  document.cookie.split( '; ' )
    .map( Cookie.fromString )
    .filter( Boolean )
)

`Cookie.fromListString<T, K>()`

Parse a cookie list string to a Map of cookies.

Type parameters

Parameter	Description
`T`	A `Record` o key-value pairs (key: cookie name, value: expected cookie value type).
`K`	Internal.

Parameters

Parameter	Type	Description
`list`	`string`	The cookie list string.

Returns

Type: TypedMap<{ [P in K]: ParsedCookieMap<P, T[P]>; }>

The Map of parsed cookies indexed by the Cookie name.

Usage

Defining custom types

/** On-site stubbed cookie names. */
enum CookieName
{
  COOKIE_1 = 'cookie-1',
  COOKIE_2 = 'cookie-2',
}

interface Cookie1
{
  test: 'value'
}

interface Cookie2
{
  test: boolean
}

type CookiesMap = {
  [ CookieName.COOKIE_1 ]: Cookie1
  [ CookieName.COOKIE_2 ]: Cookie2
}

Get parsed cookies from `Document.cookie`

const cookies     = Cookie.fromListString<CookiesMap>( document.cookie )
const cookie      = cookies.get( CookieName.COOKIE_1 ) // `ParsedCookieMap<CookieName.COOKIE_1, Cookie1> | undefined`
const cookieValue = cookie?.get( 'value' ) // `Cookie1 | undefined`

Get parsed cookies from a request `Cookie` header

const { headers } = request
const cookielist  = headers.get( 'Cookie' )

if ( cookielist ) {
  const cookies     = Cookie.fromListString<CookiesMap>( cookielist )
  const cookie      = cookies.get( CookieName.COOKIE_2 ) // `ParsedCookieMap<CookieName.COOKIE_2, Cookie2> | undefined`
  const cookieValue = cookie?.get( 'value' ) // `Cookie2 | undefined`
}

`Cookie.get<T>()`

Get a cookie by cookie name from Document.cookie.

Type parameters

Parameter	Description
`T`	The expected type for the Cookie value.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the cookie.

Returns

Type: ParsedCookieMap<typeof name, T> | undefined

The found parsed cookie.
undefined if no cookie has been found in Document.cookie.

Usage

const cookie  = Cookie.get<string>( 'access_token' )
const value   = cookie?.get( 'value' ) // `string | undefined`

`Cookie.getAll<T>()`

Get a Map of all cookies found in Document.cookie.

Type parameters

Parameter	Description
`T`	A `Record` o key-value pairs (key: cookie name, value: expected cookie value type).

Returns

Type: TypedMap<{ [P in K]: ParsedCookieMap<P, T[P]>; }>

The Map of parsed cookies indexed by the Cookie name.

Usage

const cookies = Cookie.getAll()
const cookie  = cookies.get( 'somecookie' )

`Cookie.set<K, V>()`

Set a cookie to Document.cookie.

Type parameters

Parameter	Description
`K`	The typed cookie name.
`V`	The cookie value type.

Parameters

Parameter	Type	Description
`options`	`RawCookie<K, V> \| ParsedCookieMap<K, V>`	The cookie options or a parsed Cookie Map.

Returns

Type: ParsedCookieMap<K, V> | false

The set Cookie Map if successful.
false on failure.

Usage

const cookieOptions: RawCookie = {
  name        : 'cookiename',
  value       : { test: 'value' },
  path        : '/specific-path',
  priority    : Priority.High,
  expires     : Date.now() + 20 * 60 * 1000,
  domain      : 'example.com',
  secure      : true,
  httpOnly    : false,
  sameSite    : SameSite.Lax,
  maxAge      : Date.now() + 30 * 60 * 1000,
  partitioned : true,
}

Cookie.set( cookieOptions )
// or
Cookie.set( Coookie.parse( cookieOptions ) )

`Cookie.delete()`

Delete a cookie by cookie name from Document.cookie.

Parameters

Parameter	Type	Description
`name`	`string`	The cookie name to delete.

Returns

Type: boolean

true on successfull.
false on failure.

Usage

Cookie.delete( 'some_cookie' )

`LocalStorage` Class

A browser-compatible implementation of localStorage.

Importing the class

import { LocalStorage } from '@alessiofrittoli/web-utils'
// or
import { LocalStorage } from '@alessiofrittoli/web-utils/storage/LocalStorage'

Static methods

`LocalStorage.key()`

Get storage item name by item numeric index.

Parameters

Parameter	Type	Description
`index`	`number`	The item index in the storage.

Returns

Type: string | null

The name of the nth key.
null if n is greater than or equal to the number of key/value pairs.

Usage

console.log( LocalStorage.key( 0 ) ) // Outputs: first item name if any.

`LocalStorage.getLength()`

Get the number of key/value pairs.

Returns

Type: number

The number of key/value pairs.

Usage

console.log( LocalStorage.getLength() )

`LocalStorage.get<T>()`

Get the current value associated with the given key, or undefined if the given key does not exist.

Type parameters

Parameter	Description
`T`	The expected item value type.

Parameters

Parameter	Type	Description
`key`	`string`	The item name.

Returns

Type: T | undefined

The current value associated with the given key.
undefined if the given key does not exist.

Usage

LocalStorage.get<Date>( 'expiration' )

`LocalStorage.set<T>()`

Sets the value of the pair identified by key to value, creating a new key/value pair if none existed for key previously.

Dispatches a storage event on Window objects holding an equivalent Storage object.

Type parameters

Parameter	Description
`T`	The item value type.

Parameters

Parameter	Type	Description
`key`	`string`	The item name.
`value`	`T`	The item value.

Throws

Type: DOMException

A "QuotaExceededError" DOMException exception if the new value couldn't be set. (Setting could fail if, e.g., the user has disabled storage for the site, or if the quota has been exceeded.)

Usage

LocalStorage.set<Date>( 'expiration', new Date() )

`LocalStorage.delete()`

Removes the key/value pair with the given key, if a key/value pair with the given key exists.

Dispatches a storage event on Window objects holding an equivalent Storage object.

Parameters

Parameter	Type	Description
`key`	`string`	The item name.

Usage

LocalStorage.delete( 'expiration' )

`LocalStorage.clear()`

Removes all key/value pairs, if there are any.

Dispatches a storage event on Window objects holding an equivalent Storage object.

Usage

LocalStorage.clear()

`SessionStorage` Class

A browser-compatible implementation of sessionStorage.

Same API References of LocalStorage Class is applied to the SessionStorage Class.

Please, refer to LocalStorage Class static methods API Reference for more informations.

Importing the class

import { SessionStorage } from '@alessiofrittoli/web-utils'
// or
import { SessionStorage } from '@alessiofrittoli/web-utils/storage/SessionStorage'

Development

Install depenendencies

npm install

or using pnpm

pnpm i

Build the source code

Run the following command to test and build code for distribution.

pnpm build

ESLint

warnings / errors check.

pnpm lint

Jest

Run all the defined test suites by running the following:

# Run tests and watch file changes.
pnpm test:watch

# Run tests in a CI environment.
pnpm test:ci

See package.json file scripts for more info.

Run tests with coverage.

An HTTP server is then started to serve coverage files from ./coverage folder.

⚠️ You may see a blank page the first time you run this command. Simply refresh the browser to see the updates.

test:coverage:serve

Contributing

Contributions are truly welcome!

Please refer to the Contributing Doc for more information on how to start contributing to this project.

Help keep this project up to date with GitHub Sponsor.

Security

If you believe you have found a security vulnerability, we encourage you to responsibly disclose this and NOT open a public issue. We will investigate all legitimate reports. Email security@alessiofrittoli.it to disclose any security vulnerabilities.

Made with ☕

Alessio Frittoli

https://alessiofrittoli.it | info@alessiofrittoli.it

Name		Name	Last commit message	Last commit date
Latest commit History 53 Commits
.github		.github
.vscode		.vscode
__tests__		__tests__
scripts		scripts
src		src
.editorconfig		.editorconfig
.gitignore		.gitignore
.npmignore		.npmignore
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
CONTRIBUTING.md		CONTRIBUTING.md
README.md		README.md
alessiofrittoli-env.d.ts		alessiofrittoli-env.d.ts
eslint.config.mjs		eslint.config.mjs
jest.config.ts		jest.config.ts
jest.setup.ts		jest.setup.ts
license.md		license.md
package.json		package.json
pnpm-lock.yaml		pnpm-lock.yaml
tsconfig.json		tsconfig.json
tsup.config.ts		tsup.config.ts

License

alessiofrittoli/web-utils

Folders and files

Latest commit

History

Repository files navigation

Web Utils 🛠️

Common TypeScript web utilities

Table of Contents

Getting started

API Reference

Blob utilities

Importing the utilitites

downloadBlob

Download file from HTTP Response

Generators utilities

Importing the utilitites

isGeneratorFunction

isDefaultGeneratorFunction

isAsyncGeneratorFunction

isGeneratorObject<T>

isDefaultGeneratorObject<T>

isAsyncGeneratorObject<T>

Map utilities

Importing the utilitites

Interface TypedMap<T, P, K>

getTypedMap<T, P, K>

Basic usage

Respect the given type

Promises utilities

Importing the utilitites

sleep

Strings utilities

Importing the utilitites

ucFirst

lcFirst

toCamelCase

toKebabCase

stringifyValue

parseValue

Types utilities

Validation utilities

Browser API utilities

Importing the utilitites

openBrowserPopUp

Re-focus a previously opened popup

Re-use a popup

Storage utilities

Cookie Class

Priority Enum

SameSite Enum

RawCookie<K, V>

ParsedCookie<K, V>

ParsedCookieMap<K, V>

Cookie.parse<K, V>()

Cookie.toString<K, V>()

Cookie.fromString<K, V>()

Cookie.fromListString<T, K>()

Defining custom types

Get parsed cookies from Document.cookie

Get parsed cookies from a request Cookie header

Cookie.get<T>()

Cookie.getAll<T>()

Cookie.set<K, V>()

Cookie.delete()

LocalStorage Class

LocalStorage.key()

LocalStorage.getLength()

LocalStorage.get<T>()

LocalStorage.set<T>()

LocalStorage.delete()

LocalStorage.clear()

SessionStorage Class

Development

Install depenendencies

Build the source code

ESLint

Jest

Contributing

Security

`downloadBlob`

`isGeneratorFunction`

`isDefaultGeneratorFunction`

`isAsyncGeneratorFunction`

`isGeneratorObject<T>`

`isDefaultGeneratorObject<T>`

`isAsyncGeneratorObject<T>`

Interface `TypedMap<T, P, K>`

`getTypedMap<T, P, K>`

`sleep`

`ucFirst`

`lcFirst`

`toCamelCase`

`toKebabCase`

`stringifyValue`

`parseValue`

`openBrowserPopUp`

`Cookie` Class

`Priority` Enum

`SameSite` Enum

`RawCookie<K, V>`

`ParsedCookie<K, V>`

`ParsedCookieMap<K, V>`

`Cookie.parse<K, V>()`

`Cookie.toString<K, V>()`

`Cookie.fromString<K, V>()`

`Cookie.fromListString<T, K>()`

Get parsed cookies from `Document.cookie`

Get parsed cookies from a request `Cookie` header

`Cookie.get<T>()`

`Cookie.getAll<T>()`

`Cookie.set<K, V>()`

`Cookie.delete()`

`LocalStorage` Class

`LocalStorage.key()`

`LocalStorage.getLength()`

`LocalStorage.get<T>()`

`LocalStorage.set<T>()`

`LocalStorage.delete()`

`LocalStorage.clear()`

`SessionStorage` Class