editor › Globals › LocalStorage
Class: LocalStorage
Hierarchy
↳ LocalStorage
Index
Constructors
Properties
Methods
Constructors
constructor
+ new LocalStorage(assetId: string, type: "localStorage" | "sessionStorage"): LocalStorage
Defined in src/history/LocalStorage.ts:44
Parameters:
| Name | Type | Default |
|---|---|---|
assetId |
string | "" |
type |
"localStorage" | "sessionStorage" | "localStorage" |
Returns: LocalStorage
Properties
Private assetId
• assetId: string
Defined in src/history/LocalStorage.ts:44
Private type
• type: "localStorage" | "sessionStorage"
Defined in src/history/LocalStorage.ts:43
Methods
createNew
▸ createNew(serializedData: any): Promise‹void›
Overrides ModelStorage.createNew
Defined in src/history/LocalStorage.ts:98
Creates a new model based on the serialized data in the browser's local storage
Parameters:
| Name | Type | Description |
|---|---|---|
serializedData |
any | - |
Returns: Promise‹void›
delete
▸ delete(): Promise‹void›
Defined in src/history/LocalStorage.ts:107
Removes the model from the browser's local storage
Returns: Promise‹void›
retrieve
▸ retrieve(): Promise‹any›
Overrides ModelStorage.retrieve
Defined in src/history/LocalStorage.ts:58
Returns: Promise‹any›
The serialized model currently stored in the browser's local storage
save
▸ save(modelAsAsset: any): Promise‹void›
Overrides ModelStorage.save
Defined in src/history/LocalStorage.ts:75
Saves an updated model to the browser's local storage
Parameters:
| Name | Type | Description |
|---|---|---|
modelAsAsset |
any | - |
Returns: Promise‹void›
Static isAvailable
▸ isAvailable(storageType: "localStorage" | "sessionStorage"): boolean
Overrides ModelStorage.isAvailable
Defined in src/history/LocalStorage.ts:13
Checks if the browser supports the wanted storage type and if there is enough space left see https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API/Using_the_Web_Storage_API
Parameters:
| Name | Type | Default | Description |
|---|---|---|---|
storageType |
"localStorage" | "sessionStorage" | "localStorage" | - |
Returns: boolean
Whether the requested storage type is available