hap-types/system.storage.d.ts at master · deepkolos/hap-types · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
/// <reference path="./types.d.ts"/>

/**
 * 数据存储 storage
 * @后台运行限制 无限制。后台运行详细用法参见后台运行 脚本。
 * @see https://doc.quickapp.cn/features/system/storage.html
 */
declare module '@system.storage' {
  interface Storage {
    /**
     * 读取存储内容
     * @example
     * ```js
     * storage.get({
     *   key: 'A1',
     *   success: function(data) {
     *     console.log('handling success')
     *   },
     *   fail: function(data, code) {
     *     console.log(`handling fail, code = ${code}`)
     *   }
     * })
     * ```
     */
    get(OBJECT: GetOBJECT): any;

    /**
     * 修改存储内容
     * @example
     * ```js
     * storage.set({
     *   key: 'A1',
     *   value: 'V1',
     *   success: function(data) {
     *     console.log('handling success')
     *   },
     *   fail: function(data, code) {
     *     console.log(`handling fail, code = ${code}`)
     *   }
     * })
     * ```
     */
    set(OBJECT: SetOBJECT): any;

    /**
     * 清空存储内容
     * @example
     * ```js
     * storage.clear({
     *   success: function(data) {
     *     console.log('handling success')
     *   },
     *   fail: function(data, code) {
     *     console.log(`handling fail, code = ${code}`)
     *   }
     * })
     * ```
     */
    clear(OBJECT: ClearOBJECT): any;

    /**
     * 删除存储内容
     * @example
     * ```js
     * storage.delete({
     *   key: 'A1',
     *   success: function(data) {
     *     console.log('handling success')
     *   },
     *   fail: function(data, code) {
     *     console.log(`handling fail, code = ${code}`)
     *   }
     * })
     * ```
     */
    delete(OBJECT: DeleteOBJECT): any;

    /**
     * 返回存储中某个 index 的键名
     * @since 1050
     * @example
     * ```js
     * let length = storage.length
     * ```
     */
    key(OBJECT: KeyOBJECT): any;

    /**
     * 存储里的数据项的数量
     * @since 1050
     * @readable true
     * @writeable false
     */
    readonly length: Number;
  }

  /**
   *
   * @param index 要查询的键名对应的索引
   * @param success 成功回调[可选]
   * @param fail 失败回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface KeyOBJECT {
    index: Number;
    success?: Function;
    fail?: Function;
    complete?: Function;
  }

  /**
   *
   * @param key 索引
   * @param success 成功回调[可选]
   * @param fail 失败回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface DeleteOBJECT {
    key: String;
    success?: Function;
    fail?: Function;
    complete?: Function;
  }

  /**
   *
   * @param success 成功回调[可选]
   * @param fail 失败回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface ClearOBJECT {
    success?: Function;
    fail?: Function;
    complete?: Function;
  }

  /**
   *
   * @param key 索引
   * @param value 新值。如果新值是长度为 0 的空字符串，会删除以 key 为索引的数据项[可选]
   * @param success 成功回调[可选]
   * @param fail 失败回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface SetOBJECT {
    key: String;
    value?: String;
    success?: Function;
    fail?: Function;
    complete?: Function;
  }

  /**
   *
   * @param key 索引
   * @param default 如果 key 不存在，返回 default。如果 default 未指定，返回长度为 0 的空字符串[可选]
   * @param success 成功回调[可选]
   * @param fail 失败回调[可选]
   * @param complete 执行结束后的回调[可选]
   */
  interface GetOBJECT {
    key: String;
    default?: String;
    success?: Function;
    fail?: Function;
    complete?: Function;
  }

  /**
   * 数据存储 storage
   * @后台运行限制 无限制。后台运行详细用法参见后台运行 脚本。
   * @see https://doc.quickapp.cn/features/system/storage.html
   */
  const storage: Storage;
  export default storage;
}