<script src="precache.js"></script>
(add in start of page, preferably after opening <html>)
precache(options,tempCacheName)
default value:
"@:precacheJS_TEMP_CACHE_"
the name of the partition in the cache where important precache.js information will be saved
takes the name of the .json file with caching parameters
Object (if options is string, this placed in the JSON file, else options get the Object with next properties) options:
| property | type | info | default |
|---|---|---|---|
cacheName |
String | the name of the partition in the cache where all files will be saved | "precaches" |
serviceWorkerFile |
String | url to sw.js |
"./sw.js" (in current dir) |
scope |
String | scope of service worker | ./ (dir of sw.js and maybe current dir) |
cacheFiles |
Object | list of cached files | {} |
updateIf |
Object | cache update conditions | false (will not be updated) |
general form:
{
"cacheName": "name",
"cacheFiles": {
"path": [
".",
"file1",
"file2",
...
]
},
"serviceWorkerFile": ".../file.js",
"scope": ".../",
"checkServiceWorkers": true,
"updateIf": updateOptions
}
| property | type | info | default |
|---|---|---|---|
changedFiles |
Array | names of files, when change that, the cache will update | none |
minTime |
Number | UNIX time format. After that time cache will begin to update | none |
general form:
{
"changedFiles":[
"file1",
"file2",
...
],
"minTime":1541280849213
}
- add file with options to cached files
- add
sw.jsto cached files - add cached files to
updateIf.changedFiles(it's pointless :)) - cache folders (except folders with cached files-
./.css/.someFolderWithCachedFiles/....)
precache.json (options in json)
window.precache |
arguments(if function) | info |
|---|---|---|
.cache(name) |
(String name of the cache partition) |
Takes the name of the cache partition and return Object with methods, which process him |
.worker |
returns a Promise, which resolve takes the registered worker as argument | |
.options |
returns a Promise, which resolve takes the Object options of precache(options) as argument |
|
.installCache(worker, options) |
(Object of worker , options Object) | Add files from options in cahce (if not added) |
.updateCache(worker, options) |
(Object of worker , options Object) | Add files from options in cahce (update if added) |
window.precache.cache(name) |
arguments(if function) | info |
|---|---|---|
.add(url,value) |
(String some url/name , Response object width some value) |
add/update value for key url in partition name of the cache. Returns Promise from Cache.put() |
.get(url) |
(String some url/name) |
get value for key url in partition name of the cache. Returns Object |
window.precache.cache(name).get(url) |
arguments(if function) | info |
|---|---|---|
.to(type) |
(String="text"|"json"|"fileReader"|"clone"|"Other method of Respone") |
Returns Promise of some method |
.then |
Promise from Cache.match(url) |