@minisss/cookie v1.0.3

@minisss/cookie

@minisss/cookie 是一个轻量级的 JavaScript 库，旨在简化对浏览器 Document.cookie 的操作。它提供了一组简单易用的 API，允许开发者轻松地读取、设置和删除 cookie，而无需直接处理复杂的字符串操作。

特性

• ✅ 支持 Nextjs SSR cookie 操作(传入 ctx 上下文即可)
• ✅ 内置 TS 类型提示, 重写 IMiniCookieData 获得自定义 TS 类型提示
• ✅ 支持 ESM CJS UMD
• 🤡 支持广泛浏览器
• 😄 无依赖包

安装方式

# pnpm
pnpm i @minisss/cookie

# yarn
yarn add @minisss/cookie

# npm
npm i @minisss/cookie

# bun
bun install @minisss/cookie

使用方式

ESM xxx.js

import MiniCookie from "@minisss/cookie";
MiniCookie.set("cookieName", "cookieValue");
console.log(MiniCookie.get("cookieName"));

CJS xxx.js

// CJS xxx.js
const MiniCookie = require("@minisss/cookie");
MiniCookie.set("cookieName", "cookieValue");
console.log(MiniCookie.get("cookieName"));

UMD xxx.html

// UMD xxx.html 普通 script 直接导入 -> 访问全局变量 MiniCookie
<script src="https://unpkg.com/@minisss/cookie@0.0.1-alpha.2"></script>;
<script>
  console.log("MiniCookie 包对象: ", MiniCookie)
  MiniCookie.set('cookieName', 'cookieValue')
  console.log(MiniCookie.get('cookieName'))
  console.log(MiniCookie.has('cookieName'))
</script>

// script type module 模块化内部引入方式
<script type="module">
  import MiniCookie from "https://unpkg.com/@minisss/cookie@0.0.1-alpha.2/dist/index.esm.js";
  console.log("MiniCookie 包对象: ", MiniCookie)
  MiniCookie.set('cookieName', 'cookieValue')
  console.log(MiniCookie.get('cookieName'))
  console.log(MiniCookie.has('cookieName'))
  console.log(MiniCookie.del('cookieName'))
  console.log(MiniCookie.has('cookieName'))
</script>

API

Config

覆写 IMiniCookieData 获得自定义 TS 类型提示(可选)

// 覆写 IMiniCookieData 类型接口已获得类型提示
// 例如: 在 type/xxx.d.ts | global.d.ts 中定义 IMiniCookieData 类型接口
declare namespace MiniCookie {
  interface IMiniCookieData {
    name:string
    age:number
  }
}
// 将 types/xxx.d.ts 加入到 tsconfig.json includes 中即可获得自定义类型提示功能咯