# Storage ⇐ Input Handles saving and requesting files from local storage **Kind**: global class **Extends**: Input * [Storage](#Storage) ⇐ Input * [new Storage(name)](#new_Storage_new) * _instance_ * [.createInstance()](#Storage+createInstance) * [.get(input)](#Storage+get) ⇒ Promise.<any> * [.set(input, data)](#Storage+set) ⇒ Promise.<(ArrayBuffer\|null)> * [.put(url)](#Storage+put) ⇒ Promise.<ArrayBuffer> * [.dispatch(url, [type], [withCredentials], [headers])](#Storage+dispatch) ⇒ Promise.<(Blob\|string\|JSON\|Document\|XMLDocument)> * [.getBlob(url, [mimeType])](#Storage+getBlob) ⇒ Promise.<(Blob\|null)> * [.getText(url, [mimeType])](#Storage+getText) ⇒ Promise.<(string\|null)> * [.getBase64(url, [mimeType])](#Storage+getBase64) ⇒ Promise.<(string\|null)> * [.destroy()](#Storage+destroy) * _static_ * [.name](#Storage.name) : string * [.online](#Storage.online) : boolean ## new Storage(name) Constructor | Param | Type | Description | | --- | --- | --- | | name | string | This should be the name of the application for modals | ## storage.createInstance() Create LocalForage instance **Kind**: instance method of [Storage](#Storage) ## storage.get(input) ⇒ Promise.<any> Get entry from Storage **Kind**: instance method of [Storage](#Storage) | Param | Type | Description | | --- | --- | --- | | input | string \| number | key | **Example** ```js storage.get(0).then(data => ...) ``` **Example** ```js storage.get('https://example.com/to/book.epub').then(data => ...) ``` ## storage.set(input, data) ⇒ Promise.<(ArrayBuffer\|null)> Set data into Storage **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | input | string \| number | | data | ArrayBuffer | ## storage.put(url) ⇒ Promise.<ArrayBuffer> Put data into Storage **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | url | string | ## storage.dispatch(url, [type], [withCredentials], [headers]) ⇒ Promise.<(Blob\|string\|JSON\|Document\|XMLDocument)> Dispatch a request by URL **Kind**: instance method of [Storage](#Storage) | Param | Type | Description | | --- | --- | --- | | url | string | a url to request from storage | | [type] | string | specify the type of the returned result | | [withCredentials] | boolean | | | [headers] | Array.<string> | | ## storage.getBlob(url, [mimeType]) ⇒ Promise.<(Blob\|null)> Get a Blob from Storage by URL **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | url | string | | [mimeType] | string | ## storage.getText(url, [mimeType]) ⇒ Promise.<(string\|null)> Get a Text from Storage by URL **Kind**: instance method of [Storage](#Storage) | Param | Type | | --- | --- | | url | string | | [mimeType] | string | ## storage.getBase64(url, [mimeType]) ⇒ Promise.<(string\|null)> Get a base64 encoded result from Storage by URL **Kind**: instance method of [Storage](#Storage) **Returns**: Promise.<(string\|null)> - base64 encoded | Param | Type | | --- | --- | | url | string | | [mimeType] | string | ## storage.destroy() destroy **Kind**: instance method of [Storage](#Storage) ## Storage.name : string **Kind**: static property of [Storage](#Storage) **Read only**: true ## Storage.online : boolean Current status **Kind**: static property of [Storage](#Storage) **Read only**: true