@inrupt/solid-client-authn-core / IStorageUtility

Interface: IStorageUtility¶

Table of contents¶

Methods¶

delete¶

▸ delete(key: string, options?: { secure?: undefined | boolean }): Promise<void>

Parameters:¶

Name	Type
`key`	string
`options?`	object
`options.secure?`	undefined \| boolean

Returns: Promise<void>

Defined in: src/storage/IStorageUtility.ts:37

deleteAllUserData¶

▸ deleteAllUserData(userId: string, options?: { secure?: undefined | boolean }): Promise<void>

Parameters:¶

Name	Type
`userId`	string
`options?`	object
`options.secure?`	undefined \| boolean

Returns: Promise<void>

Defined in: src/storage/IStorageUtility.ts:53

deleteForUser¶

▸ deleteForUser(userId: string, key: string, options?: { secure?: undefined | boolean }): Promise<void>

Parameters:¶

Name	Type
`userId`	string
`key`	string
`options?`	object
`options.secure?`	undefined \| boolean

Returns: Promise<void>

Defined in: src/storage/IStorageUtility.ts:48

get¶

▸ get(key: string, options?: { errorIfNull?: undefined | boolean ; secure?: undefined | boolean }): Promise<undefined | string>

Parameters:¶

Name	Type
`key`	string
`options?`	object
`options.errorIfNull?`	undefined \| boolean
`options.secure?`	undefined \| boolean

Returns: Promise<undefined | string>

Defined in: src/storage/IStorageUtility.ts:28

getForUser¶

▸ getForUser(userId: string, key: string, options?: { errorIfNull?: undefined | boolean ; secure?: undefined | boolean }): Promise<undefined | string>

Parameters:¶

Name	Type
`userId`	string
`key`	string
`options?`	object
`options.errorIfNull?`	undefined \| boolean
`options.secure?`	undefined \| boolean

Returns: Promise<undefined | string>

Defined in: src/storage/IStorageUtility.ts:38

safeGet¶

▸ safeGet(key: string, options?: Partial<{ postProcess?: undefined | (retrievedObject: any) => any ; schema?: undefined | Record<string, any> ; secure?: undefined | boolean ; userId?: undefined | string }>): Promise<any>

Retrieve from local storage

Parameters:¶

Name	Type	Description
`key`	string	The key of the item
`options?`	Partial<{ `postProcess?`: undefined \| (`retrievedObject`: any) => any ; `schema?`: undefined \| Record<string, any> ; `secure?`: undefined \| boolean ; `userId?`: undefined \| string }>	-

Returns: Promise<any>

Defined in: src/storage/IStorageUtility.ts:66

set¶

▸ set(key: string, value: string, options?: { secure?: undefined | boolean }): Promise<void>

Parameters:¶

Name	Type
`key`	string
`value`	string
`options?`	object
`options.secure?`	undefined \| boolean

Returns: Promise<void>

Defined in: src/storage/IStorageUtility.ts:32

setForUser¶

▸ setForUser(userId: string, values: Record<string, string>, options?: { secure?: undefined | boolean }): Promise<void>

Parameters:¶

Name	Type
`userId`	string
`values`	Record<string, string>
`options?`	object
`options.secure?`	undefined \| boolean

Returns: Promise<void>

Defined in: src/storage/IStorageUtility.ts:43

Interface: IStorage