Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@alwatr/local-storage

Alwatr737AGPL-3.0-only5.0.0TypeScript support: included

localJsonStorage is a utility object in our TypeScript package that provides methods for interacting with the local storage in a structured and versioned manner.

local-storage, storage, json, json-storage, JsonStorage, local-json-storage, cross-platform, ECMAScript, typescript, javascript, browser, esm, module, utility, util, utils, nanolib, alwatr

readme

ECMAScript Nano Libs

This repository contains numerous small utility packages. These packages serve various useful purposes and are written in nano ESModule without any dependencies.

Here is a brief overview of the included libraries:

  1. tsconfig-base: This is a foundational TypeScript configuration used for Alwatr projects.
  2. flat-string: The flat-string function flattens the underlying C structures of a concatenated JavaScript string.
  3. global-this: This TypeScript module provides a cross-platform alternative to globalThis named globalScope. This object works across different environments, including browsers (window), Node.js (global), and Web Workers (self).
  4. platform-info: This module offers a method to identify the current platform where the script is being executed. It defines a platformInfo constant that contains details about the current platform.
  5. prettier-config: These are Alwatr's shared configurations for Prettier.
  6. eslint-config: This is Alwatr's ECMAScript Style Guide presented as shareable ESLint configurations.
  7. deep-clone: This function allows you to clone deeply nested objects and arrays in JavaScript.
  8. nano-build: This is a tool for building/bundling ECMAScript, TypeScript, and JavaScript libraries. It's user-friendly, requires no setup, follows best practices, has no dependencies, and uses esbuild for improved performance.
  9. type-helper: Collection of useful typescript type helpers.
  10. wait: Comprehensive toolkit for managing asynchronous operations.
  11. exit-hook: A utility for registering exit handlers in Node.js.
  12. flatomise: A utility for creating promises that can be externally resolved or rejected.
  13. async-queue: A queue that executes async tasks in order like mutex and semaphore methodology for javascript and typescript.
  14. node-fs: Enhanced file system operations in Node.js, including reading, writing, and handling JSON files, with both synchronous and asynchronous options.
  15. is-number: A simple utility to check if a value is a number.
  16. parse-duration: A simple utility to parse a duration string into milliseconds number.
  17. local-storage: localJsonStorage is a utility object in our TypeScript package that provides methods for interacting with the local storage in a structured and versioned manner.
  18. polyfill-has-own: A polyfill for Object.hasOwn.
  19. fetch: Enhanced fetch API with cache strategy, retry pattern, timeout, helper methods and enhanced types.

For more detailed information and guidelines on how to use each package, please refer to each package's README.

Sponsors

The following companies, organizations, and individuals support Nanolib ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.

Exir Studio

Contributing

Contributions are welcome! Please read our contribution guidelines before submitting a pull request.

License

This project is licensed under the AGPL-3.0 License.

changelog

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

5.0.0 (2024-11-02)

⚠ BREAKING CHANGES

  • To simplify version management and ensure consistency, all nanolib packages now use the same version as @alwatr/nanolib. This may require updates to your project's dependencies.

Features

  • local-storage: If the version is greater than 1, remove the previous version. (1fdff96) by @
  • local-storage: Rewrite local storage module (5ed0f39) by @
  • local-storage: separate package from @alwatr/util (4cc22ed) by @
  • use package-tracer (cc3c5f9) by @

Bug Fixes

  • all dependeny topology (1c17f34) by @
  • local-storage: Remove unused dependency and update tsconfig references (b1caaea) by @

Code Refactoring

  • local-storage: update removeItem method to use localStorage instead of window.localStorage (9680a14) by @
  • prevent side-effects (01e00e1) by @
  • use new type-helper global types and remove all import types (08b5d08) by @
  • use the same version as @alwatr/nanolib (60eb860) by @

Miscellaneous Chores

  • include LICENSE and LEGAL files to publish (09f366f) by @
  • local-storage: change the license to AGPL-3.0 (ef7ea07) by @
  • Update build and lint scripts (392d0b7) by @
  • Update package.json exports for @alwatr packages (dacb362) by @

Dependencies update

  • bump the development-dependencies group across 1 directory with 10 updates (9ed98ff) by @
  • bump the development-dependencies group with 10 updates (fa4aaf0) by @
  • upd (451d025) by @
  • update all dependencies (1e0c30e) by @
  • update all dependencies (0e908b4) by @

1.1.8 (2024-11-02)

Note: Version bump only for package @alwatr/local-storage

1.1.7 (2024-10-25)

Code Refactoring

  • local-storage: update removeItem method to use localStorage instead of window.localStorage (9680a14) by @AliMD

1.1.6 (2024-10-12)

Note: Version bump only for package @alwatr/local-storage

1.1.5 (2024-10-11)

Code Refactoring

  • prevent side-effects (01e00e1) by @mohammadhonarvar

1.1.4 (2024-10-11)

Miscellaneous Chores

  • include LICENSE and LEGAL files to publish (09f366f) by @AliMD

1.1.3 (2024-10-11)

Note: Version bump only for package @alwatr/local-storage

1.1.2 (2024-10-10)

Dependencies update

  • bump the development-dependencies group with 10 updates (fa4aaf0) by @dependabot[bot]

1.1.1 (2024-10-08)

Note: Version bump only for package @alwatr/local-storage

1.1.0 (2024-09-29)

Features

  • local-storage: If the version is greater than 1, remove the previous version. (1fdff96) by @AliMD
  • use package-tracer (cc3c5f9) by @mohammadhonarvar

Bug Fixes

  • all dependeny topology (1c17f34) by @mohammadhonarvar

Code Refactoring

  • use new type-helper global types and remove all import types (08b5d08) by @AliMD

Miscellaneous Chores

  • local-storage: change the license to AGPL-3.0 (ef7ea07) by @ArmanAsadian
  • Update build and lint scripts (392d0b7) by @AliMD

1.0.10 (2024-09-21)

Note: Version bump only for package @alwatr/local-storage

1.0.9 (2024-09-15)

Dependencies update

  • bump the development-dependencies group across 1 directory with 10 updates (9ed98ff) by @dependabot[bot]

1.0.8 (2024-08-31)

Miscellaneous Chores

1.0.7 (2024-08-31)

Dependencies update

  • update all dependencies (1e0c30e) by @AliMD

1.0.6 (2024-07-04)

Dependencies update

  • update all dependencies (0e908b4) by @

1.0.5 (2024-05-12)

Note: Version bump only for package @alwatr/local-storage

1.0.4 (2024-04-25)

Note: Version bump only for package @alwatr/local-storage

1.0.3 (2024-03-28)

Note: Version bump only for package @alwatr/local-storage

1.0.2 (2024-01-31)

Note: Version bump only for package @alwatr/local-storage

1.0.1 (2024-01-24)

Note: Version bump only for package @alwatr/local-storage

1.0.0 (2024-01-16)

Features

  • local-storage: Rewrite local storage module (5ed0f39) by @AliMD
  • local-storage: separate package from @alwatr/util (4cc22ed) by @njfamirm

Bug Fixes

  • local-storage: Remove unused dependency and update tsconfig references (b1caaea) by @AliMD