From 826670aae0ee41a08e5f4f5f3fb5c07c3444bfcc Mon Sep 17 00:00:00 2001 From: Ozee31 Date: Wed, 31 Aug 2016 10:12:46 +0200 Subject: [PATCH] fix readme --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 7b6df09..cd1e232 100644 --- a/README.md +++ b/README.md @@ -173,6 +173,23 @@ OhMyCache.Local.set('k3', 'v3', {expire: 1}) OhMyCache.Local.getAll() // {k1: 'v1', k2: 'v2'} ``` +### Keys +Return all item's keys, doen't remove expired items +`keys()` + +#### Return +**Array** : all item's keys + +#### Exemples +```JS +OhMyCache.Local.set('k1', 'v1') +OhMyCache.Local.set('k2', 'v2', {readonly: true}) +OhMyCache.Local.set('k3', 'v3', {expire: 1}) + +// sleep 2 secondes or more +OhMyCache.Local.keys() // ['k1', 'k2', 'k3'] +``` + ### Remove Remove item if don't readonly `remove(key)`