External module: fs文件操作
Index
Interfaces
Functions
- atom
- cp
- cp
- dir
- dir
- dir
- dir
- dir
- dir
- dir
- exists
- get_fs_info
- mkdir
- mv
- pick
- read
- read_dir
- read_dir_assets
- read_file_assets
- stat
- upload
- write
- write
Functions
atom
▸ atom(filepath: string
, content: string
, encoding?: “utf8” | “ascii” | “base64”): Promise
<void
>
Defined in fs/write-file.ts:9
Parameters:
Name | Type |
---|---|
filepath | string |
content | string |
Optional encoding |
“utf8” | “ascii” | “base64” |
Returns: Promise
<void
>
cp
▸ cp(filepath: string
, destPath: string
): Promise
<void
>
Defined in fs/copy-file-assets.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
destPath | string |
Returns: Promise
<void
>
cp
▸ cp(filepath: string
, destPath: string
): Promise
<void
>
Defined in fs/copy-file.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
destPath | string |
Returns: Promise
<void
>
dir
▸ dir(): string
Defined in fs/dir/caches.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/doc.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/ext.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/ext-storage.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/lib.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/main.ts:7
Returns: string
dir
▸ dir(): string
Defined in fs/dir/tmp.ts:7
exists
▸ exists(path: string
): Promise
<boolean
>
Defined in fs/exists.ts:7
Parameters:
Name | Type |
---|---|
path | string |
Returns: Promise
<boolean
>
get_fs_info
▸ get_fs_info(): Promise
<object
>
Defined in fs/get-fs-info.ts:7
Returns: Promise
<object
>
mkdir
▸ mkdir(filepath: string
, options?: Partial
<IMkdirOptions
>): Promise
<void
>
Defined in fs/mkdir.ts:13
Parameters:
Name | Type |
---|---|
filepath | string |
Optional options |
Partial <IMkdirOptions > |
Returns: Promise
<void
>
mv
▸ mv(filepath: string
, destPath: string
): Promise
<void
>
Defined in fs/move-file.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
destPath | string |
Returns: Promise
<void
>
pick
▸ pick(documenttype: “allFiles” | “images” | “plainText” | “audio” | “video” | “pdf”): Promise
<Result
>
Defined in fs/pick-file.ts:18
选择文件
requires: 使用本原子操作需要在项目中link,命令如下: react-native link react-native-document-picker
example:
import file_picker from '@dfeidao/atom-mobile/fs/pick-file';
const res = await file_picker('allFiles');
Parameters:
Name | Type | Description |
---|---|---|
documenttype | “allFiles” | “images” | “plainText” | “audio” | “video” | “pdf” | allFiles:所有类型的文件 | images:图片 | plainText:纯文本 | audio:音频 | video:视频 | pdf |
Returns: Promise
<Result
>
read
▸ read(filepath: string
, length?: undefined
| number
, position?: undefined
| number
, encoding?: “utf8” | “ascii” | “base64”): Promise
<string
>
Defined in fs/read.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
Optional length |
undefined | number |
Optional position |
undefined | number |
Optional encoding |
“utf8” | “ascii” | “base64” |
Returns: Promise
<string
>
read_dir
▸ read_dir(dirpath: string
): Promise
<object
[]>
Defined in fs/read-dir.ts:8
Parameters:
Name | Type |
---|---|
dirpath | string |
Returns: Promise
<object
[]>
read_dir_assets
▸ read_dir_assets(dirpath: string
): Promise
<object
[]>
Defined in fs/read-dir-assets.ts:8
Parameters:
Name | Type |
---|---|
dirpath | string |
Returns: Promise
<object
[]>
___
read_file_assets
▸ read_file_assets(filepath: string
, encoding?: “utf8” | “ascii” | “base64”): Promise
<string
>
Defined in fs/read-file-assets.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
Optional encoding |
“utf8” | “ascii” | “base64” |
Returns: Promise
<string
>
stat
▸ stat(dirpath: string
): Promise
<IStatResult
>
Defined in fs/stat.ts:20
Parameters:
Name | Type |
---|---|
dirpath | string |
Returns: Promise
<IStatResult
>
upload
▸ upload(fd: IFeidaoAiMobile
, options: UploadFileOptions
, begin_cb: string
, progress_cb: string
): Promise
<object
>
Defined in fs/upload.ts:21
Parameters:
Name | Type |
---|---|
fd | IFeidaoAiMobile |
options | UploadFileOptions |
begin_cb | string |
progress_cb | string |
Returns: Promise
<object
>
write
▸ write(filepath: string
, content: string
, encoding?: “utf8” | “ascii” | “base64”): Promise
<void
>
Defined in fs/append-file.ts:8
Parameters:
Name | Type |
---|---|
filepath | string |
content | string |
Optional encoding |
“utf8” | “ascii” | “base64” |
Returns: Promise
<void
>
write
▸ write(filepath: string
, content: string
, position?: undefined
| number
, encoding?: “utf8” | “ascii” | “base64”): Promise
<void
>
Defined in fs/write.ts:7
Parameters:
Name | Type |
---|---|
filepath | string |
content | string |
Optional position |
undefined | number |
Optional encoding |
“utf8” | “ascii” | “base64” |
Returns: Promise
<void
>