quasar/ui/src/plugins/Cookies.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
153
154
155
156
157
158
159
160
161
162
{
  "meta": {
    "docsUrl": "https://v1.quasar.dev/quasar-plugins/cookies"
  },

  "injection": "$q.cookies",

  "methods": {
    "get": {
      "tsType": "CookiesGetMethodType",
      "desc": "Get cookie",
      "params": {
        "name": {
          "type": "String",
          "desc": "Cookie name",
          "required": true,
          "examples": [ "userId" ]
        }
      },
      "returns": {
        "type": [ "String", "null" ],
        "desc": "Cookie value; Returns null if cookie not found",
        "examples": [ "john12" ]
      }
    },

    "getAll": {
      "desc": "Get all cookies",
      "returns": {
        "type": "Object",
        "desc": "Object with cookie names (as keys) and their values",
        "examples": [
          "{ userId: 'john12', XFrame: 'x534' }"
        ]
      }
    },

    "set": {
      "desc": "Set cookie",
      "params": {
        "name": {
          "type": "String",
          "desc": "Cookie name",
          "required": true,
          "examples": [ "userId" ]
        },

        "value": {
          "type": "String",
          "desc": "Cookie value",
          "required": true,
          "examples": [ "john12" ]
        },

        "options": {
          "type": "Object",
          "desc": "Cookie options",
          "definition": {
            "expires": {
              "type": [ "Number", "String", "Date" ],
              "desc": "Cookie expires detail; If specified as Number, then the unit is days; If specified as String, it can either be raw stringified date or in Xd Xh Xm Xs format (see examples)",
              "examples": [ 30, "Wed, 13 Jan 2021 22:23:01 GMT", "1d", "15m", "13d", "1d 15m", "1d 3h 5m 3s" ]
            },
            "path": {
              "type": "String",
              "desc": "Cookie path",
              "examples": [ "/accounts" ]
            },
            "domain": {
              "type": "String",
              "desc": "Cookie domain",
              "examples": [ ".foo.com" ]
            },
            "sameSite": {
              "type": "String",
              "desc": "SameSite cookie option (not supported by IE11)",
              "examples": [ "Strict", "Lax" ],
              "addedIn": "v1.1.1"
            },
            "httpOnly": {
              "type": "Boolean",
              "desc": "Is cookie Http Only?"
            },
            "secure": {
              "type": "Boolean",
              "desc": "Is cookie secure? (https only)"
            },
            "other": {
              "type": "String",
              "desc": "Raw string for other cookie options; To be used as a last resort for possible newer props that are currently not yet implemented in Quasar",
              "examples": [ "SomeNewCookieProp" ],
              "addedIn": "v1.1.1"
            }
          }
        }
      }
    },

    "has": {
      "desc": "Check if cookie exists",
      "params": {
        "name": {
          "type": "String",
          "desc": "Cookie name",
          "required": true,
          "examples": [ "userId" ]
        }
      },
      "returns": {
        "type": "Boolean",
        "desc": "Does cookie exists or not?"
      }
    },

    "remove": {
      "desc": "Remove a cookie",
      "params": {
        "name": {
          "type": "String",
          "desc": "Cookie name",
          "required": true,
          "examples": [ "userId" ]
        },

        "options": {
          "type": "Object",
          "desc": "Cookie options",
          "definition": {
            "path": {
              "type": "String",
              "desc": "Cookie path",
              "examples": [ "/accounts" ]
            },
            "domain": {
              "type": "String",
              "desc": "Cookie domain",
              "examples": [ ".foo.com" ]
            }
          }
        }
      }
    },

    "parseSSR": {
      "desc": "For SSR usage only, and only on the global import (not on $q.cookies)",
      "params": {
        "ssrContext": {
          "type": "Object",
          "desc": "SSR Context Object",
          "required": true,
          "__exemption": [ "examples" ]
        }
      },
      "returns": {
        "type": "Object",
        "tsType": "Cookies",
        "desc": "Cookie object (like $q.cookies) for SSR usage purposes",
        "__exemption": [ "examples" ]
      }
    }
  }
}