quasar/ui/src/utils/web-storage.json at v1 · hipertracker/quasar · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/quasar-plugins/web-storage"
  },

  "methods": {
    "has": {
      "desc": "Check if storage item exists",
      "params": {
        "key": {
          "type": "String",
          "desc": "Entry key",
          "required": true,
          "examples": [ "userId" ]
        }
      },
      "returns": {
        "type": "Boolean",
        "desc": "Does the item exists or not?"
      }
    },

    "getLength": {
      "desc": "Get storage number of entries",
      "returns": {
        "type": "Number",
        "desc": "Number of entries",
        "examples": [ 21 ]
      }
    },

    "getItem": {
      "tsType": "WebStorageGetItemMethodType",
      "desc": "Get a storage item value",
      "params": {
        "key": {
          "type": "String",
          "desc": "Entry key",
          "required": true,
          "examples": [ "userId" ]
        }
      },
      "returns": {
        "type": [ "Date", "RegExp", "Number", "Boolean", "Function", "Object", "Array", "String", "null" ],
        "desc": "Storage item value",
        "examples": [ "john12", 702 ]
      }
    },

    "getIndex": {
      "tsType": "WebStorageGetIndexMethodType",
      "desc": "Get the storage item value at specific index",
      "params": {
        "index": {
          "type": "Number",
          "desc": "Entry index",
          "required": true,
          "examples": [ 5 ]
        }
      },
      "returns": {
        "type": [ "Number", "null" ],
        "desc": "Storage item index",
        "examples": [ 7 ]
      }
    },

    "getKey": {
      "tsType": "WebStorageGetKeyMethodType",
      "desc": "Get the storage key at specific index",
      "params": {
        "index": {
          "type": "Number",
          "desc": "Entry index",
          "required": true,
          "examples": [ 5 ]
        }
      },
      "returns": {
        "type": [ "String", "null" ],
        "desc": "Storage key",
        "examples": [ "userId" ]
      },
      "addedIn": "v1.9.4"
    },

    "getAll": {
      "desc": "Retrieve all items in storage",
      "returns": {
        "type": "Object",
        "desc": "Object syntax: item name as Object key and its value",
        "examples": [
          "{ userId: 'jon12', timesLoggedIn: 14 }"
        ]
      }
    },

    "getAllKeys": {
      "tsType": "WebStorageGetAllKeysMethodType",
      "desc": "Retrieve all keys in storage",
      "returns": {
        "type": "Array",
        "desc": "Storage keys (Array of Strings)",
        "examples": [ "['userId', 'password']" ]
      },
      "addedIn": "v1.9.4"
    },

    "set": {
      "desc": "Set item in storage",
      "params": {
        "key": {
          "type": "String",
          "desc": "Entry key",
          "required": true,
          "examples": [ "userId" ]
        },

        "value": {
          "type": [ "Date", "RegExp", "Number", "Boolean", "Function", "Object", "Array", "String", "null" ],
          "desc": "Entry value",
          "required": true,
          "examples": [ "john12" ]
        }
      }
    },

    "remove": {
      "desc": "Remove a storage item",
      "params": {
        "key": {
          "type": "String",
          "desc": "Storage key",
          "required": true,
          "examples": [ "userId" ]
        }
      }
    },

    "clear": {
      "desc": "Remove everything from the storage"
    },

    "isEmpty": {
      "desc": "Determine if storage has any items",
      "returns": {
        "type": "Boolean",
        "desc": "Tells if storage is empty or not"
      }
    }
  }
}