Variable StorageUtils`Const`

StorageUtils: {
    clearCookies(options?): void;
    clearLocal(options?): void;
    clearSession(options?): void;
    decrypt(value, key?): Promise<string>;
    encrypt(value, key?): Promise<string>;
    getAllCookies(options?): Promise<Record<string, string>>;
    getCookie(name, options?): Promise<null | string>;
    getLocal<T>(key, options?): Promise<null | T>;
    getSession<T>(key, options?): Promise<null | T>;
    getStorageQuota(): Promise<null | {
        quota: number;
        usage: number;
        remaining: number;
    }>;
    getStorageSize(value): number;
    getTotalStorageSize(type): number;
    isStorageAvailable(type): boolean;
    removeCookie(name, options?): void;
    removeLocal(key): void;
    removeSession(key): void;
    setCookie(name, value, options?): Promise<void>;
    setLocal(key, value, options?): Promise<void>;
    setSession(key, value, options?): Promise<void>;
} = ...

Type declaration

clearCookies:function
- clearCookies(options?): void
- Clears all cookies.
  Parameters
  - options: {
        exclude?: string[];
        path?: string;
        domain?: string;
    } = {}
    Clear options
    - Optional exclude?: string[]
      Cookie names to exclude from clearing
    - Optional path?: string
      Cookie path
    - Optional domain?: string
      Cookie domain
  Returns void
  Example
```
// Clear all cookies
StorageUtils.clearCookies();

// Clear cookies except 'session'
StorageUtils.clearCookies({ exclude: ['session'] });
```
  - Defined in StorageUtils.ts:42
clearLocal:function
- clearLocal(options?): void
- Clears all values from localStorage.
  Parameters
  - options: {
    exclude?: string[];
    } = {}
    Clear options
    - Optional exclude?: string[]
      Keys to exclude from clearing
  Returns void
  Example
```
// Clear all localStorage
StorageUtils.clearLocal();

// Clear localStorage except 'settings'
StorageUtils.clearLocal({ exclude: ['settings'] });
```
  - Defined in StorageUtils.ts:75
clearSession:function
- clearSession(options?): void
- Clears all values from sessionStorage.
  Parameters
  - options: {
    exclude?: string[];
    } = {}
    Clear options
    - Optional exclude?: string[]
      Keys to exclude from clearing
  Returns void
  Example
```
// Clear all sessionStorage
StorageUtils.clearSession();

// Clear sessionStorage except 'temp'
StorageUtils.clearSession({ exclude: ['temp'] });
```
  - Defined in StorageUtils.ts:109
decrypt:function
- decrypt(value, key?): Promise<string>
- Decrypts an encrypted string value.
  Parameters
  - value: string
    Value to decrypt
  - Optional key: string
    Optional encryption key (defaults to a secure key)
  Returns Promise<string>
  Promise resolving to decrypted value
  Throws
  Error if decryption fails
  
  Example
```
const decrypted = await StorageUtils.decrypt(encryptedValue);
```
  - Defined in StorageUtils.ts:141
encrypt:function
- encrypt(value, key?): Promise<string>
- Encrypts a string value.
  Parameters
  - value: string
    Value to encrypt
  - Optional key: string
    Optional encryption key (defaults to a secure key)
  Returns Promise<string>
  Promise resolving to encrypted value
  Throws
  Error if encryption fails
  
  Example
```
const encrypted = await StorageUtils.encrypt('sensitive-data');
```
  - Defined in StorageUtils.ts:178
getAllCookies:function
- getAllCookies(options?): Promise<Record<string, string>>
- Gets all cookies.
  Parameters
  - options: {
    decrypt?: boolean;
    } = {}
    Cookie options
    - Optional decrypt?: boolean
      Whether to decrypt the values
  Returns Promise<Record<string, string>>
  Object containing all cookies
  Example
```
// Get all cookies
const cookies = StorageUtils.getAllCookies();

// Get all cookies with decryption
const decryptedCookies = await StorageUtils.getAllCookies({ decrypt: true });
```
  - Defined in StorageUtils.ts:219
getCookie:function
- getCookie(name, options?): Promise<null | string>
- Gets a cookie value.
  Parameters
  - name: string
    Cookie name
  - options: {
    decrypt?: boolean;
    } = {}
    Cookie options
    - Optional decrypt?: boolean
      Whether to decrypt the value
  Returns Promise<null | string>
  Cookie value or null if not found
  Example
```
// Get a cookie
const value = StorageUtils.getCookie('theme');

// Get and decrypt a cookie
const decryptedValue = await StorageUtils.getCookie('token', { decrypt: true });
```
  - Defined in StorageUtils.ts:258
getLocal:function
- getLocal<T>(key, options?): Promise<null | T>
- Gets a value from localStorage.
  Type Parameters
  - T
  Parameters
  - key: string
    Storage key
  - options: {
    decrypt?: boolean;
    defaultValue?: T;
    } = {}
    Storage options
    - Optional decrypt?: boolean
      Whether to decrypt the value
    - Optional defaultValue?: T
      Default value if not found/expired
  Returns Promise<null | T>
  Stored value or null if not found/expired
  Example
```
// Get a value
const value = StorageUtils.getLocal<string>('name');

// Get and decrypt a value with default
const decryptedValue = await StorageUtils.getLocal<string>('token', {
  decrypt: true,
  defaultValue: 'default-token'
});
```
  - Defined in StorageUtils.ts:346
getSession:function
- getSession<T>(key, options?): Promise<null | T>
- Gets a value from sessionStorage.
  Type Parameters
  - T
  Parameters
  - key: string
    Storage key
  - options: {
    decrypt?: boolean;
    defaultValue?: T;
    } = {}
    Storage options
    - Optional decrypt?: boolean
      Whether to decrypt the value
    - Optional defaultValue?: T
      Default value if not found/expired
  Returns Promise<null | T>
  Stored value or null if not found/expired
  Example
```
// Get a value
const value = StorageUtils.getSession<string>('temp');

// Get and decrypt a value with default
const decryptedValue = await StorageUtils.getSession<string>('token', {
  decrypt: true,
  defaultValue: 'default-token'
});
```
  - Defined in StorageUtils.ts:394
getStorageQuota:function
- getStorageQuota(): Promise<null | {
      quota: number;
      usage: number;
      remaining: number;
  }>
- Gets the storage quota and usage.
  
  Returns Promise<null | {
      quota: number;
      usage: number;
      remaining: number;
  }>
  Promise resolving to object containing quota and usage information
  Example
```
const quota = await StorageUtils.getStorageQuota();
console.log(`Usage: ${quota?.usage} / ${quota?.quota}`);
```
  - Defined in StorageUtils.ts:431
getStorageSize:function
- getStorageSize(value): number
- Gets the size of a stored value.
  Parameters
  - value: unknown
    Value to measure
  Returns number
  Size in bytes
  Example
```
const size = StorageUtils.getStorageSize({ data: 'large' });
console.log(`Size: ${size} bytes`);
```
  - Defined in StorageUtils.ts:462
getTotalStorageSize:function
- getTotalStorageSize(type): number
- Gets the total size of all stored values.
  Parameters
  - type: "localStorage" | "sessionStorage"
    Storage type ('localStorage' or 'sessionStorage')
  Returns number
  Total size in bytes
  Example
```
const totalSize = StorageUtils.getTotalStorageSize('localStorage');
console.log(`Total size: ${totalSize} bytes`);
```
  - Defined in StorageUtils.ts:482
isStorageAvailable:function
- isStorageAvailable(type): boolean
- Checks if storage is available.
  Parameters
  - type: "localStorage" | "sessionStorage" | "cookie"
    Storage type ('localStorage', 'sessionStorage', or 'cookie')
  Returns boolean
  True if storage is available
  Example
```
if (StorageUtils.isStorageAvailable('localStorage')) {
  // Use localStorage
}
```
  - Defined in StorageUtils.ts:513
removeCookie:function
- removeCookie(name, options?): void
- Removes a cookie.
  Parameters
  - name: string
    Cookie name
  - options: {
    path?: string;
    domain?: string;
    } = {}
    Cookie options
    - Optional path?: string
      Cookie path
    - Optional domain?: string
      Cookie domain
  Returns void
  Example
```
StorageUtils.removeCookie('session');
```
  - Defined in StorageUtils.ts:549
removeLocal:function
- removeLocal(key): void
- Removes a value from localStorage.
  Parameters
  - key: string
    Storage key
  Returns void
  Example
```
StorageUtils.removeLocal('user');
```
  - Defined in StorageUtils.ts:576
removeSession:function
- removeSession(key): void
- Removes a value from sessionStorage.
  Parameters
  - key: string
    Storage key
  Returns void
  Example
```
StorageUtils.removeSession('temp');
```
  - Defined in StorageUtils.ts:592
setCookie:function
- setCookie(name, value, options?): Promise<void>
- Sets a cookie.
  Parameters
  - name: string
    Cookie name
  - value: string
    Cookie value
  - options: {
        expires?: number | Date;
        path?: string;
        domain?: string;
        secure?: boolean;
        sameSite?: "Strict" | "Lax" | "None";
        encrypt?: boolean;
    } = {}
    Cookie options
    - Optional expires?: number | Date
      Expiration time in milliseconds or Date
    - Optional path?: string
      Cookie path
    - Optional domain?: string
      Cookie domain
    - Optional secure?: boolean
      Whether the cookie requires HTTPS
    - Optional sameSite?: "Strict" | "Lax" | "None"
      SameSite attribute
    - Optional encrypt?: boolean
      Whether to encrypt the value
  Returns Promise<void>
  Example
```
// Set a basic cookie
StorageUtils.setCookie('theme', 'dark');

// Set a secure cookie with expiration
StorageUtils.setCookie('token', 'secret', {
  expires: 86400000,
  secure: true,
  sameSite: 'Strict'
});
```
  - Defined in StorageUtils.ts:624
setLocal:function
- setLocal(key, value, options?): Promise<void>
- Sets a value in localStorage.
  Parameters
  - key: string
    Storage key
  - value: unknown
    Value to store
  - options: {
    expires?: number;
    encrypt?: boolean;
    } = {}
    Storage options
    - Optional expires?: number
      Expiration time in milliseconds
    - Optional encrypt?: boolean
      Whether to encrypt the value
  Returns Promise<void>
  Example
```
// Set a basic value
StorageUtils.setLocal('user', { id: 1, name: 'John' });

// Set an encrypted value with expiration
StorageUtils.setLocal('token', 'secret', {
  expires: 3600000,
  encrypt: true
});
```
  - Defined in StorageUtils.ts:687
setSession:function
- setSession(key, value, options?): Promise<void>
- Sets a value in sessionStorage.
  Parameters
  - key: string
    Storage key
  - value: unknown
    Value to store
  - options: {
    expires?: number;
    encrypt?: boolean;
    } = {}
    Storage options
    - Optional expires?: number
      Expiration time in milliseconds
    - Optional encrypt?: boolean
      Whether to encrypt the value
  Returns Promise<void>
  Example
```
// Set a basic value
StorageUtils.setSession('temp', { id: 1 });

// Set an encrypted value with expiration
StorageUtils.setSession('token', 'secret', {
  expires: 3600000,
  encrypt: true
});
```
  - Defined in StorageUtils.ts:730

Variable StorageUtilsConst

Type declaration

clearCookies:function

Parameters

Optional exclude?: string[]

Optional path?: string

Optional domain?: string

Returns void

Example

clearLocal:function

Parameters

Optional exclude?: string[]

Returns void

Example

clearSession:function

Parameters

Optional exclude?: string[]

Returns void

Example

decrypt:function

Parameters

Returns Promise<string>

Throws

Example

encrypt:function

Parameters

Returns Promise<string>

Throws

Example

getAllCookies:function

Parameters

Optional decrypt?: boolean

Returns Promise<Record<string, string>>

Example

getCookie:function

Parameters

Optional decrypt?: boolean

Returns Promise<null | string>

Example

getLocal:function

Type Parameters

Parameters

Optional decrypt?: boolean

Optional defaultValue?: T

Returns Promise<null | T>

Example

getSession:function

Type Parameters

Parameters

Optional decrypt?: boolean

Optional defaultValue?: T

Returns Promise<null | T>

Example

getStorageQuota:function

Returns Promise<null | { quota: number; usage: number; remaining: number; }>

Example

getStorageSize:function

Parameters

Returns number

Example

getTotalStorageSize:function

Parameters

Returns number

Example

isStorageAvailable:function

Parameters

Returns boolean

Example

removeCookie:function

Parameters

Optional path?: string

Optional domain?: string

Returns void

Example

removeLocal:function

Parameters

Returns void

Example

removeSession:function

Parameters

Variable StorageUtils`Const`

`Optional` exclude?: string[]

`Optional` path?: string

`Optional` domain?: string

`Optional` exclude?: string[]

`Optional` exclude?: string[]

`Optional` decrypt?: boolean

`Optional` decrypt?: boolean

`Optional` decrypt?: boolean

`Optional` defaultValue?: T

`Optional` decrypt?: boolean

`Optional` defaultValue?: T

Returns Promise<null | {
quota: number;
usage: number;
remaining: number;
}>

`Optional` path?: string

`Optional` domain?: string

`Optional` expires?: number | Date

`Optional` path?: string

`Optional` domain?: string

`Optional` secure?: boolean

`Optional` sameSite?: "Strict" | "Lax" | "None"

`Optional` encrypt?: boolean

`Optional` expires?: number

`Optional` encrypt?: boolean

`Optional` expires?: number

`Optional` encrypt?: boolean