@lingxia/types 0.5.0 → 0.5.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/file/index.d.ts +33 -4
- package/dist/file/index.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/file/index.ts +38 -4
- package/src/index.ts +2 -2
package/dist/file/index.d.ts
CHANGED
|
@@ -58,15 +58,44 @@ export interface ChooseDirectoryResult {
|
|
|
58
58
|
export interface DownloadOptions {
|
|
59
59
|
/** HTTP(S) source URL. */
|
|
60
60
|
url: string;
|
|
61
|
+
/** Optional request headers. */
|
|
62
|
+
headers?: Record<string, string>;
|
|
63
|
+
/** Request timeout in milliseconds. */
|
|
64
|
+
timeout?: number;
|
|
65
|
+
/** Optional destination path. Relative paths resolve under user data. */
|
|
66
|
+
filePath?: string;
|
|
67
|
+
/** Optional abort signal. */
|
|
68
|
+
signal?: AbortSignal;
|
|
69
|
+
}
|
|
70
|
+
export interface DownloadProgressEvent {
|
|
71
|
+
kind: 'progress' | 'paused' | 'resumed' | 'canceled' | 'success';
|
|
72
|
+
downloadedBytes?: number;
|
|
73
|
+
totalBytes?: number;
|
|
74
|
+
/** Present only when the total size is known. */
|
|
75
|
+
progress?: number;
|
|
76
|
+
result?: DownloadResult;
|
|
77
|
+
}
|
|
78
|
+
export interface DownloadIteratorResult {
|
|
79
|
+
done: boolean;
|
|
80
|
+
value?: DownloadProgressEvent;
|
|
61
81
|
}
|
|
62
82
|
export interface DownloadResult {
|
|
63
|
-
/**
|
|
64
|
-
|
|
65
|
-
/** Suggested filename resolved by runtime from headers/url. */
|
|
66
|
-
fileName: string;
|
|
83
|
+
/** Final accessible file path or URI. */
|
|
84
|
+
filePath: string;
|
|
67
85
|
/** MIME type when available. */
|
|
68
86
|
mimeType?: string;
|
|
69
87
|
/** File size in bytes. */
|
|
70
88
|
size: number;
|
|
71
89
|
}
|
|
90
|
+
export interface DownloadTask extends PromiseLike<DownloadResult>, AsyncIterable<DownloadProgressEvent> {
|
|
91
|
+
next(): Promise<DownloadIteratorResult>;
|
|
92
|
+
return(): Promise<DownloadIteratorResult>;
|
|
93
|
+
catch<TResult = never>(onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null): Promise<DownloadResult | TResult>;
|
|
94
|
+
finally(onfinally?: (() => void) | null): Promise<DownloadResult>;
|
|
95
|
+
pause(): Promise<void>;
|
|
96
|
+
resume(): Promise<void>;
|
|
97
|
+
cancel(): Promise<void>;
|
|
98
|
+
abort(): Promise<void>;
|
|
99
|
+
wait(): Promise<DownloadResult>;
|
|
100
|
+
}
|
|
72
101
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/file/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,eAAe;IAC9B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtC,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oEAAoE;IACpE,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,+DAA+D;IAC/D,QAAQ,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,sEAAsE;AACtE,MAAM,WAAW,sBAAsB;IACrC,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,qBAAqB;IACpC,+DAA+D;IAC/D,QAAQ,EAAE,OAAO,CAAC;IAClB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/file/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,eAAe;IAC9B,oDAAoD;IACpD,QAAQ,EAAE,MAAM,CAAC;IACjB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,UAAU,CAAC;IACtC,0FAA0F;IAC1F,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,iDAAiD;IACjD,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,4DAA4D;IAC5D,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,iBAAiB;IAChC,qDAAqD;IACrD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oEAAoE;IACpE,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,+DAA+D;IAC/D,QAAQ,EAAE,OAAO,CAAC;IAClB,oEAAoE;IACpE,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,sEAAsE;AACtE,MAAM,WAAW,sBAAsB;IACrC,mEAAmE;IACnE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,0EAA0E;IAC1E,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,sEAAsE;AACtE,MAAM,WAAW,qBAAqB;IACpC,+DAA+D;IAC/D,QAAQ,EAAE,OAAO,CAAC;IAClB,+EAA+E;IAC/E,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,0BAA0B;IAC1B,GAAG,EAAE,MAAM,CAAC;IACZ,gCAAgC;IAChC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,uCAAuC;IACvC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yEAAyE;IACzE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,6BAA6B;IAC7B,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,UAAU,GAAG,QAAQ,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,CAAC;IACjE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,cAAc,CAAC;CACzB;AAED,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,qBAAqB,CAAC;CAC/B;AAED,MAAM,WAAW,cAAc;IAC7B,yCAAyC;IACzC,QAAQ,EAAE,MAAM,CAAC;IACjB,gCAAgC;IAChC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAa,SAAQ,WAAW,CAAC,cAAc,CAAC,EAAE,aAAa,CAAC,qBAAqB,CAAC;IACrG,IAAI,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;IACxC,MAAM,IAAI,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAC1C,KAAK,CAAC,OAAO,GAAG,KAAK,EACnB,UAAU,CAAC,EAAE,CAAC,CAAC,MAAM,EAAE,OAAO,KAAK,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,IAAI,GACxE,OAAO,CAAC,cAAc,GAAG,OAAO,CAAC,CAAC;IACrC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,IAAI,CAAC,GAAG,IAAI,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAClE,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IACvB,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,CAAC;CACjC"}
|
package/dist/index.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ import type { AppConfig, AppInstance, LxAppInfo, PageConfig, PageInstance } from
|
|
|
22
22
|
import type { DeviceInfo, ScreenInfo, MakePhoneCallOptions, WifiInfo, ConnectWifiOptions, WifiConnectedCallback, NetworkInfo, NetworkChangeCallback } from './device';
|
|
23
23
|
import type { KeyEventCallback } from './input';
|
|
24
24
|
import type { LxEnv, Storage } from './storage';
|
|
25
|
-
import type { OpenFileOptions, ChooseDirectoryOptions, ChooseDirectoryResult, ChooseFileOptions, ChooseFileResult, DownloadOptions,
|
|
25
|
+
import type { OpenFileOptions, ChooseDirectoryOptions, ChooseDirectoryResult, ChooseFileOptions, ChooseFileResult, DownloadOptions, DownloadTask } from './file';
|
|
26
26
|
import type { DeviceOrientation, DeviceOrientationChangeEvent } from './display';
|
|
27
27
|
import type { GetLocationOptions, LocationInfo } from './location';
|
|
28
28
|
import type { AppBaseInfo, SystemSettingInfo, OpenURLOptions } from './system';
|
|
@@ -56,7 +56,7 @@ export interface Lx {
|
|
|
56
56
|
* otherwise prefer `mode: 'auto'`.
|
|
57
57
|
*/
|
|
58
58
|
openFile(options: OpenFileOptions): void;
|
|
59
|
-
downloadFile(options: DownloadOptions):
|
|
59
|
+
downloadFile(options: DownloadOptions): DownloadTask;
|
|
60
60
|
getStorage(): Storage;
|
|
61
61
|
getLocation(options?: GetLocationOptions): Promise<LocationInfo>;
|
|
62
62
|
navigateToLxApp(options: NavigateToLxAppOptions): Promise<void>;
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,UAAU,EACV,YAAY,EACb,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,WAAW,EACX,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,KAAK,EACV,KAAK,EACL,OAAO,EACR,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EACV,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,cAAc,OAAO,CAAC;AACtB,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,QAAQ,CAAC;AACvB,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,UAAU,CAAC;AACzB,cAAc,UAAU,CAAC;AACzB,cAAc,SAAS,CAAC;AACxB,cAAc,MAAM,CAAC;AACrB,cAAc,SAAS,CAAC;AACxB,cAAc,mBAAmB,CAAC;AAClC,cAAc,kBAAkB,CAAC;AAEjC,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EACX,SAAS,EACT,UAAU,EACV,YAAY,EACb,MAAM,OAAO,CAAC;AAEf,OAAO,KAAK,EACV,UAAU,EACV,UAAU,EACV,oBAAoB,EACpB,QAAQ,EACR,kBAAkB,EAClB,qBAAqB,EACrB,WAAW,EACX,qBAAqB,EACtB,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,SAAS,CAAC;AAEhD,OAAO,KAAK,EACV,KAAK,EACL,OAAO,EACR,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EACV,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,YAAY,EACb,MAAM,QAAQ,CAAC;AAEhB,OAAO,KAAK,EACV,iBAAiB,EACjB,4BAA4B,EAC7B,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACb,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EACV,WAAW,EACX,iBAAiB,EACjB,cAAc,EACf,MAAM,UAAU,CAAC;AAElB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAE9C,OAAO,KAAK,EACV,mBAAmB,EACnB,SAAS,EACT,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,mBAAmB,EACnB,mBAAmB,EACnB,SAAS,EACT,4BAA4B,EAC5B,2BAA2B,EAC3B,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,cAAc,EACd,YAAY,EACb,MAAM,SAAS,CAAC;AAEjB,OAAO,KAAK,EACV,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,4BAA4B,EAC5B,4BAA4B,EAC5B,mBAAmB,EACnB,qBAAqB,EACrB,wBAAwB,EACxB,qBAAqB,EACrB,oBAAoB,EACpB,gBAAgB,EAChB,eAAe,EACf,WAAW,EACZ,MAAM,MAAM,CAAC;AAEd,MAAM,WAAW,EAAE;IACjB,GAAG,EAAE,KAAK,CAAC;IAEX,aAAa,IAAI,UAAU,CAAC;IAC5B,aAAa,IAAI,UAAU,CAAC;IAC5B,YAAY,IAAI,OAAO,CAAC;IACxB,WAAW,IAAI,OAAO,CAAC;IACvB,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAEtD,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC3B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1B,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxD,WAAW,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC;IACnC,gBAAgB,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC;IACtC,eAAe,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACvD,gBAAgB,CAAC,QAAQ,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACzD,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IACvC,eAAe,CAAC,QAAQ,EAAE,qBAAqB,GAAG,IAAI,CAAC;IACvD,gBAAgB,CAAC,QAAQ,CAAC,EAAE,qBAAqB,GAAG,IAAI,CAAC;IAEzD,oBAAoB,CAAC,WAAW,EAAE,iBAAiB,GAAG,OAAO,CAAC;IAC9D,yBAAyB,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,GAAG,IAAI,CAAC;IACzF,0BAA0B,CAAC,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,4BAA4B,KAAK,IAAI,GAAG,IAAI,CAAC;IAE3F;;;;OAIG;IACH,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IACzC,YAAY,CAAC,OAAO,EAAE,eAAe,GAAG,YAAY,CAAC;IAErD,UAAU,IAAI,OAAO,CAAC;IAEtB,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAEjE,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,iBAAiB,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEnC,cAAc,IAAI,WAAW,CAAC;IAC9B,YAAY,IAAI,SAAS,CAAC;IAC1B,gBAAgB,IAAI,iBAAiB,CAAC;IACtC,OAAO,CAAC,OAAO,EAAE,cAAc,GAAG,IAAI,CAAC;IAEvC,gBAAgB,IAAI,aAAa,CAAC;IAElC,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/D,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC3E,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAAC;IAC3E,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;IAC/D,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAEnG,WAAW,CAAC,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,EAAE,CAAC,CAAC;IAEvE;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IAExE,sBAAsB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACjE,sBAAsB,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjE,QAAQ,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;IAE7D,kBAAkB,CAAC,WAAW,EAAE,MAAM,GAAG,YAAY,CAAC;IAEtD,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC3C,SAAS,IAAI,IAAI,CAAC;IAElB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAE3D,eAAe,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAE7E,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAClE,YAAY,CAAC,OAAO,EAAE,mBAAmB,GAAG,IAAI,CAAC;IACjD,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACpD,QAAQ,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElD,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC;IACtE,qBAAqB,CAAC,OAAO,EAAE,4BAA4B,GAAG,OAAO,CAAC;IACtE,cAAc,IAAI,OAAO,CAAC;IAE1B,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC;IACxD,gBAAgB,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC;IACxD,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC;IACxD,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC;IAC9D,UAAU,IAAI,OAAO,CAAC;IACtB,UAAU,IAAI,OAAO,CAAC;IACtB,cAAc,CAAC,OAAO,EAAE,qBAAqB,GAAG,OAAO,CAAC;IACxD,aAAa,CAAC,OAAO,EAAE,oBAAoB,GAAG,OAAO,CAAC;IAEtD,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/D,SAAS,IAAI,IAAI,CAAC;IAElB,oBAAoB,IAAI,IAAI,CAAC;IAC7B,mBAAmB,IAAI,IAAI,CAAC;IAE5B,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;IAEvC,sEAAsE;IACtE,UAAU,CAAC,OAAO,CAAC,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IACnE,sEAAsE;IACtE,eAAe,CAAC,OAAO,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElF,SAAS,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC5C,UAAU,CAAC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC9C,OAAO,CAAC,QAAQ,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC1C,QAAQ,CAAC,QAAQ,CAAC,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC7C;AAED,OAAO,CAAC,MAAM,CAAC;IACb,MAAM,EAAE,EAAE,EAAE,CAAC;IAEb,SAAS,GAAG,CAAC,MAAM,EAAE,SAAS,GAAG,WAAW,CAAC;IAC7C,SAAS,MAAM,CAAC,CAAC,SAAS,WAAW,GAAG,WAAW,KAAK,CAAC,GAAG,IAAI,CAAC;IACjE,SAAS,IAAI,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3E,MAAM,EAAE,UAAU,CAAC,KAAK,CAAC,GAAG,QAAQ,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC,GAC5E,IAAI,CAAC;IACR,SAAS,eAAe,CAAC,CAAC,SAAS,YAAY,GAAG,YAAY,KAAK,CAAC,EAAE,CAAC;CACxE;AAED,OAAO,EAAE,CAAC"}
|
package/package.json
CHANGED
package/src/file/index.ts
CHANGED
|
@@ -65,15 +65,49 @@ export interface ChooseDirectoryResult {
|
|
|
65
65
|
export interface DownloadOptions {
|
|
66
66
|
/** HTTP(S) source URL. */
|
|
67
67
|
url: string;
|
|
68
|
+
/** Optional request headers. */
|
|
69
|
+
headers?: Record<string, string>;
|
|
70
|
+
/** Request timeout in milliseconds. */
|
|
71
|
+
timeout?: number;
|
|
72
|
+
/** Optional destination path. Relative paths resolve under user data. */
|
|
73
|
+
filePath?: string;
|
|
74
|
+
/** Optional abort signal. */
|
|
75
|
+
signal?: AbortSignal;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
export interface DownloadProgressEvent {
|
|
79
|
+
kind: 'progress' | 'paused' | 'resumed' | 'canceled' | 'success';
|
|
80
|
+
downloadedBytes?: number;
|
|
81
|
+
totalBytes?: number;
|
|
82
|
+
/** Present only when the total size is known. */
|
|
83
|
+
progress?: number;
|
|
84
|
+
result?: DownloadResult;
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
export interface DownloadIteratorResult {
|
|
88
|
+
done: boolean;
|
|
89
|
+
value?: DownloadProgressEvent;
|
|
68
90
|
}
|
|
69
91
|
|
|
70
92
|
export interface DownloadResult {
|
|
71
|
-
/**
|
|
72
|
-
|
|
73
|
-
/** Suggested filename resolved by runtime from headers/url. */
|
|
74
|
-
fileName: string;
|
|
93
|
+
/** Final accessible file path or URI. */
|
|
94
|
+
filePath: string;
|
|
75
95
|
/** MIME type when available. */
|
|
76
96
|
mimeType?: string;
|
|
77
97
|
/** File size in bytes. */
|
|
78
98
|
size: number;
|
|
79
99
|
}
|
|
100
|
+
|
|
101
|
+
export interface DownloadTask extends PromiseLike<DownloadResult>, AsyncIterable<DownloadProgressEvent> {
|
|
102
|
+
next(): Promise<DownloadIteratorResult>;
|
|
103
|
+
return(): Promise<DownloadIteratorResult>;
|
|
104
|
+
catch<TResult = never>(
|
|
105
|
+
onrejected?: ((reason: unknown) => TResult | PromiseLike<TResult>) | null,
|
|
106
|
+
): Promise<DownloadResult | TResult>;
|
|
107
|
+
finally(onfinally?: (() => void) | null): Promise<DownloadResult>;
|
|
108
|
+
pause(): Promise<void>;
|
|
109
|
+
resume(): Promise<void>;
|
|
110
|
+
cancel(): Promise<void>;
|
|
111
|
+
abort(): Promise<void>;
|
|
112
|
+
wait(): Promise<DownloadResult>;
|
|
113
|
+
}
|
package/src/index.ts
CHANGED
|
@@ -53,7 +53,7 @@ import type {
|
|
|
53
53
|
ChooseFileOptions,
|
|
54
54
|
ChooseFileResult,
|
|
55
55
|
DownloadOptions,
|
|
56
|
-
|
|
56
|
+
DownloadTask,
|
|
57
57
|
} from './file';
|
|
58
58
|
|
|
59
59
|
import type {
|
|
@@ -151,7 +151,7 @@ export interface Lx {
|
|
|
151
151
|
* otherwise prefer `mode: 'auto'`.
|
|
152
152
|
*/
|
|
153
153
|
openFile(options: OpenFileOptions): void;
|
|
154
|
-
downloadFile(options: DownloadOptions):
|
|
154
|
+
downloadFile(options: DownloadOptions): DownloadTask;
|
|
155
155
|
|
|
156
156
|
getStorage(): Storage;
|
|
157
157
|
|