@maiyunnet/kebab 2.0.7 → 2.0.9

package/lib/dns.js

@@ -1,4 +1,9 @@
 "use strict";
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-6-19
+ * Last: 2022-09-12 20:58:07, 2024-2-21 17:55:54, 2025-6-13 19:08:56
+ */
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -35,16 +40,25 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Dns = exports.ERecordLine = exports.RECORD_TYPE = exports.ESERVICE = void 0;
 exports.get = get;
+// --- 库和定义 ---
 const net = __importStar(require("../lib/net"));
 const core = __importStar(require("../lib/core"));
 const text = __importStar(require("../lib/text"));
 const crypto = __importStar(require("../lib/crypto"));
 const response = __importStar(require("../lib/net/response"));
+/**
+ * 0.DNSPod：https://www.dnspod.cn/docs/index.html（腾讯云也请使用 DNSPod 的 API）
+ * 1.阿里云：https://help.aliyun.com/document_detail/29745.html
+ */
+/** --- 服务商定义 --- */
 var ESERVICE;
 (function (ESERVICE) {
     ESERVICE[ESERVICE["DNSPOD"] = 0] = "DNSPOD";
     ESERVICE[ESERVICE["ALIBABA"] = 1] = "ALIBABA";
 })(ESERVICE || (exports.ESERVICE = ESERVICE = {}));
+/**
+ * --- 记录值类型 ---
+ */
 exports.RECORD_TYPE = {
     'A': 'A',
     'NS': 'NS',
@@ -54,6 +68,9 @@ exports.RECORD_TYPE = {
     'SRV': 'SRV',
     'AAAA': 'AAAA'
 };
+/**
+ * --- 记录值线路 ---
+ */
 var ERecordLine;
 (function (ERecordLine) {
     ERecordLine[ERecordLine["DEFAULT"] = 0] = "DEFAULT";
@@ -88,6 +105,10 @@ class Dns {
         opt.secretKey ??= config.dns?.[ESERVICE[opt.service]].skey;
         this._opt = opt;
     }
+    /**
+     * --- 最终发送 ---
+     * @param obj 要发送的信息
+     */
     async _send(obj) {
         for (const key in obj) {
             if (obj[key] === null || obj[key] === undefined) {
@@ -95,6 +116,7 @@ class Dns {
             }
         }
         switch (this._opt.service) {
+            // --- DNSPod ---
             case ESERVICE.DNSPOD: {
                 const data = Object.assign({
                     'login_token': (this._opt.secretId ?? '') + '.' + (this._opt.secretKey ?? ''),
@@ -102,8 +124,9 @@ class Dns {
                 }, obj);
                 const path = data['_path'];
                 delete data['_path'];
-                return net.post('https://dnsapi.cn/' + path, data);
+                return net.post('https://dnsapi.cn/' + path, data); // 境外 api 会自动调度到香港服务器
             }
+            // --- 阿里云 ---
             case ESERVICE.ALIBABA: {
                 const getData = core.objectSort(Object.assign({
                     'Format': 'JSON',
@@ -116,13 +139,18 @@ class Dns {
                 }, obj));
                 const urlRight = text.queryStringify(getData);
                 const signature = crypto.hashHmac('sha1', `GET&${encodeURIComponent('/')}&${encodeURIComponent(urlRight)}`, (this._opt.secretKey ?? '') + '&', 'base64');
-                return net.get(`https://alidns.aliyuncs.com/?${urlRight}&Signature=${encodeURIComponent(signature)}`);
+                return net.get(`https://alidns.aliyuncs.com/?${urlRight}&Signature=${encodeURIComponent(signature)}`); // 境外 api 会自动调度到新加坡服务器
             }
         }
         return new response.Response(null);
     }
+    /**
+     * --- 获取域名列表 ---
+     * @param opt 参数
+     */
     async getDomainList(opt) {
         switch (this._opt.service) {
+            // --- DNSPod ---
             case ESERVICE.DNSPOD: {
                 const rtn = await this._send({
                     '_path': 'Domain.List',
@@ -148,6 +176,7 @@ class Dns {
                 }
                 return r;
             }
+            // --- 阿里云 ---
             case ESERVICE.ALIBABA: {
                 const length = opt.length ?? 20;
                 const rtn = await this._send({
@@ -177,10 +206,15 @@ class Dns {
         }
         return null;
     }
+    /**
+     * --- 添加记录 ---
+     * @param opt 参数
+     */
     async addDomainRecord(opt) {
         const line = opt.line ?? ERecordLine.DEFAULT;
         const ttl = opt.ttl ?? 600;
         switch (this._opt.service) {
+            // --- DNSPod ---
             case ESERVICE.DNSPOD: {
                 const rtn = await this._send({
                     '_path': 'Record.Create',
@@ -203,6 +237,7 @@ class Dns {
                 };
                 return r;
             }
+            // --- 阿里云 ---
             case ESERVICE.ALIBABA: {
                 const rtn = await this._send({
                     'Action': 'AddDomainRecord',
@@ -228,11 +263,17 @@ class Dns {
         }
         return null;
     }
+    /**
+     * --- 修改记录 ---
+     * @param opt 参数
+     */
     async updateDomainRecord(opt) {
         const line = opt.line ?? ERecordLine.DEFAULT;
         const ttl = opt.ttl ?? 600;
         switch (this._opt.service) {
+            // --- DNSPod ---
             case ESERVICE.DNSPOD: {
+                // --- DNSPod 必须传 domain ---
                 const rtn = await this._send({
                     '_path': 'Record.Modify',
                     'domain': opt.domain,
@@ -255,6 +296,7 @@ class Dns {
                 };
                 return r;
             }
+            // --- 阿里云 ---
             case ESERVICE.ALIBABA: {
                 const rtn = await this._send({
                     'Action': 'UpdateDomainRecord',
@@ -280,8 +322,13 @@ class Dns {
         }
         return null;
     }
+    /**
+     * --- 删除记录 ---
+     * @param opt 参数
+     */
     async deleteDomainRecord(opt) {
         switch (this._opt.service) {
+            // --- DNSPod ---
             case ESERVICE.DNSPOD: {
                 const rtn = await this._send({
                     '_path': 'Record.Remove',
@@ -297,6 +344,7 @@ class Dns {
                     'success': json.status.code === '1' ? true : false
                 };
             }
+            // --- 阿里云 ---
             case ESERVICE.ALIBABA: {
                 const rtn = await this._send({
                     'Action': 'DeleteDomainRecord',
@@ -316,6 +364,10 @@ class Dns {
     }
 }
 exports.Dns = Dns;
+/**
+ * --- 创建一个第三方 Dns 对象 ---
+ * @param opt 选项
+ */
 function get(ctr, opt) {
     return new Dns(ctr, opt);
 }

package/lib/fs.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-3-29 23:03:07
+ * Last: 2020-3-11 22:21:51, 2022-12-29 01:18:25, 2023-12-13 20:50:09
+ */
 import * as fs from 'fs';
 import * as http from 'http';
 import * as http2 from 'http2';
@@ -10,25 +15,102 @@ export declare function getContent(path: string, options: BufferEncoding | {
     'start'?: number;
     'end'?: number;
 }): Promise<string | null>;
+/**
+ * --- 写入文件内容 ---
+ * @param path 文件路径
+ * @param data 要写入的内容
+ * @param options 选项
+ */
 export declare function putContent(path: string, data: string | Buffer, options?: {
     'encoding'?: BufferEncoding;
     'mode'?: number;
     'flag'?: string;
 }): Promise<boolean>;
+/**
+ * --- 读取链接的 target ---
+ * @param path 要读取的路径
+ * @param encoding 编码
+ */
 export declare function readLink(path: string, encoding?: BufferEncoding): Promise<string | null>;
+/**
+ * --- 把源文件创建一个 link ---
+ * @param filePath 源文件
+ * @param linkPath 连接路径
+ * @param type 仅 Windows，类型，默认 file
+ */
 export declare function symlink(filePath: string, linkPath: string, type?: 'dir' | 'file' | 'junction'): Promise<boolean>;
+/**
+ * --- 删除一个文件 ---
+ * @param path 要删除的文件路径
+ */
 export declare function unlink(path: string): Promise<boolean>;
+/**
+ * --- 获取对象是否存在，存在则返回 stats 对象，否则返回 null ---
+ * @param path 对象路径
+ */
 export declare function stats(path: string): Promise<fs.Stats | null>;
+/**
+ * --- 判断是否是目录或目录是否存在，是的话返回 stats ---
+ * @param path 判断路径
+ */
 export declare function isDir(path: string): Promise<fs.Stats | false>;
+/**
+ * --- 判断是否是文件或文件是否存在，是的话返回 stats ---
+ * @param path 判断路径
+ */
 export declare function isFile(path: string): Promise<fs.Stats | false>;
+/**
+ * --- 深度创建目录，如果最末目录存在，则自动创建成功 ---
+ * @param path 要创建的路径，如 /a/b/c/
+ * @param mode 权限
+ */
 export declare function mkdir(path: string, mode?: number): Promise<boolean>;
+/**
+ * --- 删除空目录 ---
+ * @param path 要删除的目录
+ */
 export declare function rmdir(path: string): Promise<boolean>;
+/**
+ * --- Danger 危险：危险函数，尽量不要使用 ---
+ * --- This f**king is a danger function, please don't use it ---
+ * --- 删除一个非空目录 ---
+ */
 export declare function rmdirDeep(path: string): Promise<boolean>;
+/**
+ * --- 修改权限
+ * @param path 要修改的路径
+ * @param mod 权限
+ */
 export declare function chmod(path: string, mod: string | number): Promise<boolean>;
+/**
+ * --- 重命名/移动 文件文件夹 ---
+ * @param oldPath 老名
+ * @param newPath 新名
+ */
 export declare function rename(oldPath: string, newPath: string): Promise<boolean>;
+/**
+ * --- 获取文件夹下文件列表 ---
+ * @param path 文件夹路径
+ */
 export declare function readDir(path: string, encoding?: BufferEncoding): Promise<fs.Dirent[]>;
+/**
+ * --- 复制文件夹里的内容到另一个地方，失败不会回滚 ---
+ * @param from 源，末尾加 /
+ * @param to 目标，末尾加 /
+ * @param ignore 忽略的文件
+ */
 export declare function copyFolder(from: string, to: string, ignore?: RegExp[]): Promise<number>;
+/**
+ * --- 复制文件 ---
+ * @param src 源文件
+ * @param dest 目标文件
+ */
 export declare function copyFile(src: string, dest: string): Promise<boolean>;
+/**
+ * --- 创建读取文件的流 ---
+ * @param path 文件地址
+ * @param options 编码或配置
+ */
 export declare function createReadStream(path: string, options?: BufferEncoding | {
     'flags'?: string;
     'encoding'?: BufferEncoding;
@@ -36,9 +118,20 @@ export declare function createReadStream(path: string, options?: BufferEncoding
     'start'?: number;
     'end'?: number;
 }): fs.ReadStream;
+/**
+ * --- 读取文件写入到流，并等待写入完成 ---
+ * @param path 文件地址
+ * @param destination 要写入的流
+ * @param options 写入后是否终止写入流，默认终止
+ */
 export declare function pipe(path: string, destination: NodeJS.WritableStream, options?: {
     'end'?: boolean;
 }): Promise<boolean>;
+/**
+ * --- 创建写入文件的流 ---
+ * @param path 文件地址
+ * @param options 编码或配置
+ */
 export declare function createWriteStream(path: string, options?: BufferEncoding | {
     'flags'?: string;
     'encoding'?: BufferEncoding;
@@ -46,4 +139,11 @@ export declare function createWriteStream(path: string, options?: BufferEncoding
     'autoClose'?: boolean;
     'start'?: number;
 }): fs.WriteStream;
+/**
+ * --- 读取文件并输出到 http 的 response ---
+ * @param path 文件绝对路径
+ * @param req http 请求对象
+ * @param res http 响应对象
+ * @param stat 文件的 stat（如果有）
+ */
 export declare function readToResponse(path: string, req: http2.Http2ServerRequest | http.IncomingMessage, res: http2.Http2ServerResponse | http.ServerResponse, stat?: fs.Stats | null): Promise<void>;

package/lib/fs.js

@@ -53,12 +53,22 @@ exports.createReadStream = createReadStream;
 exports.pipe = pipe;
 exports.createWriteStream = createWriteStream;
 exports.readToResponse = readToResponse;
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2019-3-29 23:03:07
+ * Last: 2020-3-11 22:21:51, 2022-12-29 01:18:25, 2023-12-13 20:50:09
+ */
 const fs = __importStar(require("fs"));
 const http2 = __importStar(require("http2"));
 const mime = __importStar(require("@litert/mime"));
 const text = __importStar(require("./text"));
 const core = __importStar(require("./core"));
 const zlib = __importStar(require("./zlib"));
+/**
+ * --- 读取完整文件或一段 ---
+ * @param path 文件路径
+ * @param options 编码或选项
+ */
 async function getContent(path, options) {
     if (typeof options === 'string') {
         options = {
@@ -113,6 +123,12 @@ async function getContent(path, options) {
         }
     }
 }
+/**
+ * --- 写入文件内容 ---
+ * @param path 文件路径
+ * @param data 要写入的内容
+ * @param options 选项
+ */
 async function putContent(path, data, options = {}) {
     try {
         await fs.promises.writeFile(path, data, options);
@@ -122,6 +138,11 @@ async function putContent(path, data, options = {}) {
         return false;
     }
 }
+/**
+ * --- 读取链接的 target ---
+ * @param path 要读取的路径
+ * @param encoding 编码
+ */
 async function readLink(path, encoding) {
     try {
         return await fs.promises.readlink(path, {
@@ -132,6 +153,12 @@ async function readLink(path, encoding) {
         return null;
     }
 }
+/**
+ * --- 把源文件创建一个 link ---
+ * @param filePath 源文件
+ * @param linkPath 连接路径
+ * @param type 仅 Windows，类型，默认 file
+ */
 async function symlink(filePath, linkPath, type) {
     try {
         await fs.promises.symlink(filePath, linkPath, type);
@@ -141,6 +168,10 @@ async function symlink(filePath, linkPath, type) {
         return false;
     }
 }
+/**
+ * --- 删除一个文件 ---
+ * @param path 要删除的文件路径
+ */
 async function unlink(path) {
     for (let i = 0; i <= 2; ++i) {
         try {
@@ -159,6 +190,10 @@ async function unlink(path) {
         return false;
     }
 }
+/**
+ * --- 获取对象是否存在，存在则返回 stats 对象，否则返回 null ---
+ * @param path 对象路径
+ */
 async function stats(path) {
     try {
         return await fs.promises.lstat(path);
@@ -167,6 +202,10 @@ async function stats(path) {
         return null;
     }
 }
+/**
+ * --- 判断是否是目录或目录是否存在，是的话返回 stats ---
+ * @param path 判断路径
+ */
 async function isDir(path) {
     const pstats = await stats(path);
     if (!pstats?.isDirectory()) {
@@ -174,6 +213,10 @@ async function isDir(path) {
     }
     return pstats;
 }
+/**
+ * --- 判断是否是文件或文件是否存在，是的话返回 stats ---
+ * @param path 判断路径
+ */
 async function isFile(path) {
     const pstats = await stats(path);
     if (!pstats?.isFile()) {
@@ -181,10 +224,16 @@ async function isFile(path) {
     }
     return pstats;
 }
+/**
+ * --- 深度创建目录，如果最末目录存在，则自动创建成功 ---
+ * @param path 要创建的路径，如 /a/b/c/
+ * @param mode 权限
+ */
 async function mkdir(path, mode = 0o755) {
     if (await isDir(path)) {
         return true;
     }
+    // --- 深度创建目录 ---
     try {
         await fs.promises.mkdir(path, {
             'recursive': true,
@@ -196,6 +245,10 @@ async function mkdir(path, mode = 0o755) {
         return false;
     }
 }
+/**
+ * --- 删除空目录 ---
+ * @param path 要删除的目录
+ */
 async function rmdir(path) {
     if (!(await isDir(path))) {
         return true;
@@ -208,6 +261,11 @@ async function rmdir(path) {
         return false;
     }
 }
+/**
+ * --- Danger 危险：危险函数，尽量不要使用 ---
+ * --- This f**king is a danger function, please don't use it ---
+ * --- 删除一个非空目录 ---
+ */
 async function rmdirDeep(path) {
     if (!path.endsWith('/')) {
         path += '/';
@@ -219,6 +277,7 @@ async function rmdirDeep(path) {
             return false;
         }
         if (stat.isDirectory()) {
+            // --- 目录 ---
             const rtn = await rmdirDeep(path + item.name);
             if (!rtn) {
                 return false;
@@ -233,6 +292,11 @@ async function rmdirDeep(path) {
     }
     return rmdir(path);
 }
+/**
+ * --- 修改权限
+ * @param path 要修改的路径
+ * @param mod 权限
+ */
 async function chmod(path, mod) {
     try {
         await fs.promises.chmod(path, mod);
@@ -242,6 +306,11 @@ async function chmod(path, mod) {
         return false;
     }
 }
+/**
+ * --- 重命名/移动 文件文件夹 ---
+ * @param oldPath 老名
+ * @param newPath 新名
+ */
 async function rename(oldPath, newPath) {
     try {
         await fs.promises.rename(oldPath, newPath);
@@ -251,6 +320,10 @@ async function rename(oldPath, newPath) {
         return false;
     }
 }
+/**
+ * --- 获取文件夹下文件列表 ---
+ * @param path 文件夹路径
+ */
 async function readDir(path, encoding) {
     try {
         const list = [];
@@ -270,12 +343,21 @@ async function readDir(path, encoding) {
         return [];
     }
 }
+/**
+ * --- 复制文件夹里的内容到另一个地方，失败不会回滚 ---
+ * @param from 源，末尾加 /
+ * @param to 目标，末尾加 /
+ * @param ignore 忽略的文件
+ */
 async function copyFolder(from, to, ignore = []) {
     let num = 0;
+    // --- 如果源目录不存在或不是目录，则直接成功 :) ---
     if (!await isDir(from)) {
         return 0;
     }
+    // --- 遍历源目录文件和文件夹，准备复制 ---
     const flist = await readDir(from);
+    /** --- to 目录是否检查是否存在，空目录不复制，所以确定有 item file 的时候才创建 --- */
     let checkTo = false;
     for (const item of flist) {
         if (item.isDirectory()) {
@@ -288,6 +370,7 @@ async function copyFolder(from, to, ignore = []) {
             }
         }
         else if (item.isFile()) {
+            // --- 先判断本文件是否被排除 ---
             if (ignore.length > 0 && text.match(item.name, ignore)) {
                 continue;
             }
@@ -305,6 +388,11 @@ async function copyFolder(from, to, ignore = []) {
     }
     return num;
 }
+/**
+ * --- 复制文件 ---
+ * @param src 源文件
+ * @param dest 目标文件
+ */
 async function copyFile(src, dest) {
     try {
         await fs.promises.copyFile(src, dest);
@@ -314,6 +402,11 @@ async function copyFile(src, dest) {
         return false;
     }
 }
+/**
+ * --- 创建读取文件的流 ---
+ * @param path 文件地址
+ * @param options 编码或配置
+ */
 function createReadStream(path, options) {
     if (typeof options === 'string') {
         options = {
@@ -331,6 +424,12 @@ function createReadStream(path, options) {
         'end': options.end
     });
 }
+/**
+ * --- 读取文件写入到流，并等待写入完成 ---
+ * @param path 文件地址
+ * @param destination 要写入的流
+ * @param options 写入后是否终止写入流，默认终止
+ */
 function pipe(path, destination, options) {
     return new Promise((resolve) => {
         createReadStream(path).on('error', function () {
@@ -340,6 +439,11 @@ function pipe(path, destination, options) {
         }).pipe(destination, options);
     });
 }
+/**
+ * --- 创建写入文件的流 ---
+ * @param path 文件地址
+ * @param options 编码或配置
+ */
 function createWriteStream(path, options) {
     if (typeof options === 'string') {
         options = {
@@ -357,6 +461,13 @@ function createWriteStream(path, options) {
         'start': options.start
     });
 }
+/**
+ * --- 读取文件并输出到 http 的 response ---
+ * @param path 文件绝对路径
+ * @param req http 请求对象
+ * @param res http 响应对象
+ * @param stat 文件的 stat（如果有）
+ */
 async function readToResponse(path, req, res, stat) {
     if (!stat) {
         stat = await stats(path);
@@ -367,14 +478,17 @@ async function readToResponse(path, req, res, stat) {
         res.end('<h1>404 Not found</h1><hr>Kebab');
         return;
     }
+    // --- 判断缓存以及 MIME 和编码 ---
     let charset = '';
     const mimeData = mime.getData(path);
     if (['htm', 'html', 'css', 'js', 'xml', 'jpg', 'jpeg', 'svg', 'gif', 'png'].includes(mimeData.extension)) {
         charset = '; charset=utf-8';
+        // --- 这些文件可能需要缓存 ---
         const hash = `W/"${stat.size.toString(16)}-${stat.mtime.getTime().toString(16)}"`;
         const lastModified = stat.mtime.toUTCString();
         res.setHeader('etag', hash);
         res.setHeader('cache-control', 'public, max-age=600');
+        // --- 判断返回 304 吗 ---
         const noneMatch = req.headers['if-none-match'];
         const modifiedSince = req.headers['if-modified-since'];
         if ((hash === noneMatch) && (lastModified === modifiedSince)) {
@@ -387,9 +501,12 @@ async function readToResponse(path, req, res, stat) {
     else {
         res.setHeader('cache-control', 'no-cache, must-revalidate');
     }
+    // --- 设置 type ---
     res.setHeader('content-type', mimeData.mime + charset);
+    // --- 判断客户端支持的压缩模式 ---
     const encoding = req.headers['accept-encoding'] ?? '';
     if (mimeData.compressible && (stat.size >= 1024)) {
+        // --- 压缩 ---
         const compress = await zlib.compress(encoding, await getContent(path));
         if (compress) {
             res.setHeader('content-encoding', compress.type);
@@ -399,6 +516,7 @@ async function readToResponse(path, req, res, stat) {
             return;
         }
     }
+    // --- 不压缩 ---
     res.setHeader('content-length', stat.size);
     res.writeHead(200);
     await pipe(path, res instanceof http2.Http2ServerResponse ? (res.stream ?? res) : res);

package/lib/jwt.d.ts

@@ -1,3 +1,8 @@
+/**
+ * Project: Kebab, User: JianSuoQiYue
+ * Date: 2023-1-31 20:34:47
+ * Last: 2023-1-31 20:34:47, 2023-12-8 13:55:09
+ */
 import * as kv from '../lib/kv';
 import * as ctr from '../sys/ctr';
 import * as types from '../types';
@@ -9,22 +14,60 @@ export interface IOptions {
     'auth'?: boolean;
 }
 export declare class Jwt {
+    /** --- Kv --- */
     private _link?;
+    /** --- 在前端或 Kv 中储存的名前缀 --- */
     private _name;
+    /** --- 有效期 --- */
     private _ttl;
+    /** --- cookie 模式时是否仅支持 SSL --- */
     private _ssl;
+    /** --- 验证密钥 --- */
     private _secret;
+    /** --- 是否从头部读取 --- */
     private _auth;
+    /** --- ctr 对象 --- */
     private _ctr;
+    /**
+     * --- 初始化函数，相当于 construct ---
+     * @param ctr 模型实例
+     * @param link Kv 或 Db 实例
+     * @param auth 设为 true 则优先从头 Authorization 或 post _auth 值读取 token
+     * @param opt 选项
+     */
     init(ctr: ctr.Ctr, opt?: IOptions, link?: kv.Pool): Promise<boolean>;
+    /**
+     * --- 将 _jwt 数据封装并返回（创建新的或者续期老的 token），默认会同时设置一个 cookie（data 值会自动设置 token、exp） ---
+     */
     renew(): string;
+    /**
+     * --- 清除 cookie，仅仅清除 cookie，jwt 并不会失效 ---
+     */
     clearCookie(): void;
+    /**
+     * --- 销毁 jwt，其实就是将 token block 信息写入 redis，如果没有 redis 则不能销毁，返回数组代表销毁成功的 token 和原 exp，否则失败返回 false ---
+     */
     destory(): Promise<{
         token: string;
         exp: number;
     } | boolean>;
 }
+/**
+ * --- 获取 jwt 原始字符串，不保证有效 ---
+ */
 export declare function getOrigin(ctr: ctr.Ctr, name?: string, auth?: boolean): string;
+/**
+ * --- decode ---
+ * 不传入 link 的话，将不做 block 有效校验，只做本身的 exp 有效校验
+ */
 export declare function decode(ctr: ctr.Ctr, val: string, link?: kv.Pool, name?: string, secret?: string): Promise<Record<string, types.DbValue> | false>;
+/**
+ * --- 仅往 redis 写禁止相关 token 的数据，一般用于异步通知时在异处的服务器来调用的 ---
+ */
 export declare function block(ctr: ctr.Ctr, token: string, exp: number, link: kv.Pool, name?: string): Promise<boolean>;
+/**
+ * @param ctr 模型实例
+ * @param opt name, ttl, ssl, secret, auth: false, true 则优先从头 Authorization 或 post _auth 值读取 token
+ * @param link 实例
+ */
 export declare function get(ctr: ctr.Ctr, opt?: IOptions, link?: kv.Pool): Promise<Jwt>;