类:Cookies

    Process:
    此类不从 'electron' 模块导出. 它只能作为 Electron API 中其他方法的返回值。

    通过Sessioncookies属性来访问Cookies的实例

    例如:

    以下事件会在Cookies实例触发。

    Event: ‘changed’

    • event Event
    • cookie Cookie - 变更后的 cookie 值。
    • cause string - 导致更改的原因,为以下值之一:
      • overwrite - 一个覆盖原值的插入操作导致的 cookie 被自动删除。
      • expired - cookie 在过期时自动删除。
      • evicted - 在GC(垃圾回收机制)过程中被回收。
      • expired-overwrite - 一个已过期的时间覆写了原cookie 的过期时间。
    • removed boolean - true 表示cookie 已被删掉, 否则为 false.

    该事件在cookie 被添加、修改、删除或过期时触发。

    实例方法

    以下方法可以在实例调用。

    cookies.get(filter)

    • filter Object
      • url string (可选) - 检索与 url 相关的 cookie。 空意味着检索所有 URL 的 cookie 。
      • namestring (可选) - 按名称筛选 cookie。
      • domain string (optional) - 检索与域名或者 domain 子域名匹配的cookie。
      • pathstring (可选) - 检索路径与 path 匹配的 cookie。
      • secureboolean (可选) - 通过其Secure 属性筛选 cookie。

    返回 Promise<Cookie[]> - 一个会解析成数组或者 cookie 对象的 promise。

    发送请求以获取匹配 filter 的所有 cookie,并通过响应来解决承诺问题。

    cookies.set(details)

    • details Object
      • url string - 与 cookie 关联的 url。 如果URL无效,promise将返回reject。
      • name string (可选) - cookie 的名称。 如果省略则默认为空。
      • value string (可选) - cookie 的值。 如果省略则默认为空。
      • domain string (可选) - cookie所在域名,通常使用点号开头,以使其对子域名可用。 如果省略则默认为空。
      • string (可选) - cookie 的路径。 如果省略则默认为空。
      • secure boolean (可选) - cookie 是否应该标记为Secure。 默认为 false 直到 Same Site=None 属性被使用
      • httpOnly boolean (可选) - cookie 是否应该标记为 HTTP only。 默认值为 false.
      • expirationDateDouble (可选) - cookie 的到期日期,类型为时间戳,单位为秒。 如果省略, 则 cookie 将成为会话 cookie, 并且不会在会话之间保留。
      • sameSite string (可选) - 要应用于此 cookie 的 策略。 可以被设置为unspecifiedno_restrictionlax或者strict 默认值为 lax.

    details 去设置一个 cookie。

    cookies.remove(url, name)

    • urlstring - 与 cookie 关联的 URL。

    返回 Promise<void> - cookie 移除时解析的的一个 promise。

    移除与urlname匹配的 cookie。

    cookies.flushStore()

    返回 Promise<void> - 一个在 cookie 写入时解析的 promise。