cookie.d.ts 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. export interface CookieOptions {
  2. /**
  3. * 键
  4. */
  5. name?: string;
  6. /**
  7. * 值
  8. */
  9. value?: string;
  10. /**
  11. * 路径
  12. */
  13. path?: string;
  14. /**
  15. * 作用域
  16. */
  17. domain?: string;
  18. /**
  19. * 设置为安全的,只能用https协议
  20. */
  21. secure?: string;
  22. /**
  23. * 过期时间,可以指定日期或者字符串,默认天
  24. */
  25. expires?: string;
  26. }
  27. export interface XECookie {
  28. /**
  29. * 根据 name 判断 Cookie 是否存在
  30. * @param name 键
  31. */
  32. has(name: string): boolean;
  33. /**
  34. * 添加 Cookie
  35. * @param name 键
  36. * @param value 值
  37. * @param options 可选参数
  38. */
  39. set(name: string, value: any, options?: CookieOptions): this;
  40. /**
  41. * 根据 name 获取 Cookie
  42. * @param name 键
  43. */
  44. get(name: string): string;
  45. /**
  46. * 根据 name 删除 Cookie
  47. * @param name 键
  48. * @param options 可选参数
  49. */
  50. remove(name: string, options?: CookieOptions): number;
  51. /**
  52. * 获取 Cookie 所有键
  53. */
  54. keys(): any[];
  55. /**
  56. * 获取所有 Cookie
  57. */
  58. getJSON(): any;
  59. }
  60. /**
  61. * Cookie 操作函数
  62. */
  63. export declare function cookie(): XECookie;
  64. /**
  65. * Cookie 操作函数
  66. * @param name 键/数组/对象
  67. */
  68. export declare function cookie(name: string): XECookie;
  69. /**
  70. * Cookie 操作函数
  71. * @param name 键/数组/对象
  72. * @param value 值
  73. */
  74. export declare function cookie(name: string, value: any): XECookie;
  75. /**
  76. * Cookie 操作函数
  77. * @param name 键/数组/对象
  78. * @param value 值
  79. * @param options 可选参数
  80. */
  81. export declare function cookie(name: string, value: any, options: CookieOptions): XECookie;
  82. declare module './ctor' {
  83. interface XEUtilsMethods {
  84. cookie: typeof cookie;
  85. }
  86. }
  87. export default cookie