CapacitorCookies

Capacitor Cookies API 通过修补 document.cookie 以使用原生库来提供原生 cookie 支持。它还提供了在特定 URL 修改 cookie 的方法。此插件随 @capacitor/core 一起提供。

配置

默认情况下，使用原生库修补 document.cookie 的功能是禁用的。 如果您想启用此功能，请在 capacitor.config 文件中修改以下配置。

属性	类型	描述	默认值
enabled	boolean	启用对 document.cookie 的修补以使用原生库。	false

配置示例

在 capacitor.config.json 中：

{
  "plugins": {
    "CapacitorCookies": {
      "enabled": true
    }
  }
}

在 capacitor.config.ts 中：

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorCookies: {
      enabled: true,
    },
  },
};

export default config;

示例

import { CapacitorCookies } from '@capacitor/core';

const getCookies = () => {
  return document.cookie;
};

const setCookie = () => {
  document.cookie = key + '=' + value;
};

const setCapacitorCookie = async () => {
  await CapacitorCookies.setCookie({
    url: 'http://example.com',
    key: 'language',
    value: 'en',
  });
};

const deleteCookie = async () => {
  await CapacitorCookies.deleteCookie({
    url: 'https://example.com',
    key: 'language',
  });
};

const clearCookiesOnUrl = async () => {
  await CapacitorCookies.clearCookies({
    url: 'https://example.com',
  });
};

const clearAllCookies = async () => {
  await CapacitorCookies.clearAllCookies();
};

iOS 上的第三方 Cookie

从 iOS 14 开始，默认情况下无法使用第三方 cookie。将以下行添加到您的 Info.plist 文件中以获得更好的 iOS cookie 支持。您最多可以添加 10 个域名。

<key>WKAppBoundDomains</key>
<array>
  <string>www.mydomain.com</string>
  <string>api.mydomain.com</string>
  <string>www.myothercooldomain.com</string>
</array>

API

• getCookies(...)
• setCookie(...)
• deleteCookie(...)
• clearCookies(...)
• clearAllCookies()
• Interfaces
• Type Aliases

getCookies(...)

getCookies(options?: GetCookieOptions) => Promise<HttpCookieMap>

参数	类型
options	GetCookieOptions

返回：

Promise<HttpCookieMap>

---

setCookie(...)

setCookie(options: SetCookieOptions) => Promise<void>

向设备写入一个 cookie。

参数	类型
options	SetCookieOptions

---

deleteCookie(...)

deleteCookie(options: DeleteCookieOptions) => Promise<void>

从设备删除一个 cookie。

参数	类型
options	DeleteCookieOptions

---

clearCookies(...)

clearCookies(options: ClearCookieOptions) => Promise<void>

清除设备上指定 URL 的 cookie。

参数	类型
options	ClearCookieOptions

---

clearAllCookies()

clearAllCookies() => Promise<void>

清除设备上的所有 cookie。

---

接口

HttpCookieMap

HttpCookie

属性	类型	描述
url	string	cookie 的 URL。
key	string	cookie 的键。
value	string	cookie 的值。

HttpCookieExtras

属性	类型	描述
path	string	写入 cookie 的路径。
expires	string	cookie 的过期日期。

类型别名

GetCookieOptions

Omit<HttpCookie, 'key' | 'value'>

Omit

Construct a type with the properties of T except for those in type K.

Pick<T, Exclude<keyof T, K>>

Pick

From T, pick a set of properties whose keys are in the union K

{ [P in K]: T[P]; }

Exclude

Exclude from T those types that are assignable to U

T extends U ? never : T

SetCookieOptions

HttpCookie & HttpCookieExtras

DeleteCookieOptions

Omit<HttpCookie, 'value'>

ClearCookieOptions

Omit<HttpCookie, 'key' | 'value'>