Skip to main content
Cypress应用

clearLocalStorage

清除当前域名及子域名下的 localStorage 数据。

caution

Cypress 默认会在每个测试用例执行_前_自动清空所有 localStorage,以防止在启用测试隔离时状态跨测试共享。除非你需要在一个测试用例内部清除 localStorage 或禁用了测试隔离,否则不应使用此命令。

语法

cy.clearLocalStorage()
cy.clearLocalStorage(key)
cy.clearLocalStorage(options)
cy.clearLocalStorage(keys, options)

用法

正确用法

cy.clearLocalStorage() // 清除所有 localStorage

参数

keys (字符串, 正则表达式)

指定要清除的 localStorage 键名。

options (对象)

传入选项对象以修改 cy.clearLocalStorage() 的默认行为。

选项默认值描述
logtrue命令日志中显示该命令

生成结果 了解主题管理

  • cy.clearLocalStorage() 返回当前域名的 localStorage 对象。

示例

无参数

清除所有 localStorage

cy.clearLocalStorage()

指定键名

清除键名为 'appName' 的 localStorage

cy.clearLocalStorage('appName')

清除所有匹配 /app-/ 正则表达式的 localStorage

cy.clearLocalStorage(/app-/)

规则

要求 了解命令链

  • cy.clearLocalStorage() 必须通过 cy 链式调用。

断言 了解断言

  • cy.clearLocalStorage() 仅会执行一次已链接的断言,且不会自动重试

超时设置 了解超时机制

  • cy.clearLocalStorage() 不会超时。

命令日志

清除所有 localStorage

cy.clearLocalStorage(/prop1|2/).then((ls) => {
expect(ls.getItem('prop1')).to.be.null
expect(ls.getItem('prop2')).to.be.null
expect(ls.getItem('prop3')).to.eq('magenta')
})

以上命令将在命令日志中显示为:

clearLocalStorage 命令日志

当点击命令日志中的 clearLocalStorage 时,控制台将输出:

clearLocalStorage 的 console.log 输出

另请参阅