Soft Storage Soft Storage
⌘ K
Guide
API
  • Vue 3 Demo
  • React Demo
  • English
  • 简体中文
Guide
API
  • Vue 3 Demo
  • React Demo
  • English
  • 简体中文
  • API
    • Vue Hooks API
    • React Hooks API
    • Hooks API
    • Core API
    • Shared API
  • Type Definition
    • Vue Hooks Types
    • React Hooks Types
    • Hooks Types
    • Core Types
    • Shared Types

API Reference

API #

Vue Hooks API

  • createLocalStorage()
  • createSessionStorage()
  • useStorage()
  • useStorageHelper()

React Hooks API

  • createLocalStorage()
  • createSessionStorage()
  • useStorage()
  • useStorageHelper()

Hooks API

  • createLocalStorage()
  • createSessionStorage()
  • useStorage()
  • useStorageHelper()

Core API

  • StorageModule()
  • storageModule.getItem()
  • storageModule.setItem()
  • storageModule.removeItem()
  • storageModule.clear()
  • storageModule.contains()
  • storageModule.size()
  • storageModule.getHelper()
  • helper.getModule()
  • helper.setModule()
  • helper.clearModule()
  • helper.getStorageKey()
  • helper.getStorageType()
  • helper.getExistence()
  • helper.protect()
  • helper.cancelProtect()

Shared API

  • createProxy()
  • restorePrefixedString()
  • restoreSuffixedString()

Type Definition #

Vue Hooks Types

  • StorageRefs
  • StorageResetters
  • StorageCheckers
  • SoftStorage
  • StorageReactions
  • CreateStorageOptions

React Hooks Types

  • Setter
  • UseState
  • SoftStorage
  • SetterKey
  • StorageState
  • StateKey
  • StorageStates
  • CreateStorageOptions

Hooks Types

  • SoftStorage
  • CreateStorageBaseOptions
  • CreateStorageOptions
  • StorageItem
  • StorageInstance
  • StorageHelper

Core Types

  • StorageType
  • IStorageModuleHelper
  • IStorageModule

Shared Types

  • Function
  • BiFunction
  • Supplier
  • Runnable
  • Consumer
  • BiConsumer
  • StorageModuleSchema
  • ResetterKey
  • CheckerKey
  • Resetter
  • Checker
  • PrefixedKey
  • SuffixedKey
  • RestorePrefixedKey
  • RestoreSuffixedKey
  • PrefixedKeys
  • SuffixedKeys
  • IsOptional
  • OptionalKeys
  • PickNonNullable