__CAPGO_KEEP_0__

インストール

bun add @capgo/capacitor-file
bunx cap sync

インポート

import { CapacitorFile } from '@capgo/capacitor-file';

API の概要

requestFileSystem

ファイル システムを要求します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.requestFileSystem({} as RequestFileSystemOptions);

resolveLocalFileSystemURL

エントリに変換する URL を解決します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.resolveLocalFileSystemURL({} as ResolveURLOptions);

getFile

ファイル エントリを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getFile({} as GetFileOptions);

getDirectory

ディレクトリエントリを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getDirectory({} as GetDirectoryOptions);

readFile

クリップボードにコピー

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.readFile({} as ReadFileOptions);

readAsDataURL

ファイルにデータを書き込みます。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.readAsDataURL({} as ReadFileOptions);

writeFile

__CAPGO_KEEP_0__

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.writeFile({} as WriteFileOptions);

appendFile

ファイルにデータを追加します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.appendFile({} as WriteFileOptions);

deleteFile

ファイルを削除します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.deleteFile({} as DeleteFileOptions);

mkdir

ディレクトリを作成します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.mkdir({} as MkdirOptions);

rmdir

ディレクトリを削除します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.rmdir({} as DeleteDirectoryOptions);

readdir

ディレクトリの内容を読み取る

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.readdir({} as ReaddirOptions);

stat

コピー

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.stat({} as StatOptions);

getMetadata

ファイルまたはディレクトリを移動またはリネームする

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getMetadata({} as StatOptions);

rename

__CAPGO_KEEP_1__

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.rename({} as RenameOptions);

move

ファイルまたはディレクトリを移動します。 rename()のエイリアス。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.move({} as RenameOptions);

copy

ファイルまたはディレクトリをコピーします。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.copy({} as CopyOptions);

exists

ファイルまたはディレクトリが存在するかどうかを確認します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.exists({} as ExistsOptions);

getUri

ファイルのURIを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getUri({} as GetUriOptions);

truncate

指定されたサイズにファイルを短縮します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.truncate({} as TruncateOptions);

getDirectories

すべてのファイルシステムディレクトリを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getDirectories();

getFreeDiskSpace

バイト単位の空きディスクスペースを取得します。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.getFreeDiskSpace();

checkPermissions

ファイル操作の現在の許可状態を確認します。 Androidでは外部ストレージの許可をチェックします。 iOSとWebでは常に‘granted’を返します。特殊な許可が必要ないためです。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.checkPermissions();

requestPermissions

ファイル操作のためのパーミッションを要求します。 Androidの場合、このAPIはアプリのプライベートディレクトリ外のファイルへのアクセスに必要な外部ストレージパーミッションを要求します。 iOSとWebの場合、このAPIは常に「許可」が返されます。なぜなら、特別なパーミッションは必要ないからです。

import { CapacitorFile } from '@capgo/capacitor-file';

await CapacitorFile.requestPermissions();

タイプ リファレンス

RequestFileSystemOptions

ファイル システムの要求オプション

export interface RequestFileSystemOptions {
  /** The type of file system to request */
  type: FileSystemType;
  /** Requested size in bytes (may not be enforced on all platforms) */
  size?: number;
}

FileSystem

ファイル システムを表します。

export interface FileSystem {
  /** The name of the file system */
  name: string;
  /** The root directory of the file system */
  root: DirectoryEntry;
}

ResolveURLOptions

__CAPGO_KEEP_0__を解決するためのオプション。

export interface ResolveURLOptions {
  /** The URL to resolve (file:// or cdvfile://) */
  url: string;
}

Entry

ファイルまたはディレクトリエントリを表します。

export interface Entry {
  /** True if this is a file */
  isFile: boolean;
  /** True if this is a directory */
  isDirectory: boolean;
  /** The name of the file or directory */
  name: string;
  /** The full path relative to the filesystem root */
  fullPath: string;
  /** The native file:// URI */
  nativeURL: string;
}

GetFileOptions

ファイルを取得するためのオプション。

export interface GetFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the file */
  options?: GetOptions;
}

FileEntry

ファイルエントリを表します。

export interface FileEntry extends Entry {
  isFile: true;
  isDirectory: false;
}

GetDirectoryOptions

ディレクトリの取得オプション。

export interface GetDirectoryOptions {
  /** Path to the directory */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Options for creating the directory */
  options?: GetOptions;
}

DirectoryEntry

ディレクトリエントリを表します。

export interface DirectoryEntry extends Entry {
  isFile: false;
  isDirectory: true;
}

ReadFileOptions

ファイルを読み取るためのオプション。

export interface ReadFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Encoding for text files (omit for binary/base64) */
  encoding?: Encoding;
  /** Byte offset to start reading from (default: 0) */
  offset?: number;
  /** Number of bytes to read (default: read to end of file) */
  length?: number;
}

ReadFileResult

ファイルの読み取り結果です。

export interface ReadFileResult {
  /** File contents as string (text) or base64 (binary) */
  data: string;
}

WriteFileOptions

ファイルを書き出すためのオプション。

export interface WriteFileOptions {
  /** Path to the file */
  path: string;
  /** Base directory */
  directory?: Directory;
  /** Data to write (string for text, base64 for binary) */
  data: string;
  /** Encoding for text files */
  encoding?: Encoding;
  /** If true, append to existing file instead of overwriting */
  append?: boolean;
  /** Create intermediate directories if they don't exist */
  recursive?: boolean;
  /** Byte position to start writing at (for random access writes). If not specified, writes from beginning or appends based on 'append' flag */
  position?: number;
}

WriteFileResult

ファイルを書き出す結果

export interface WriteFileResult {
  /** The URI of the written file */
  uri: string;
}

真実の源

このページはプラグインの src/definitions.tsパブリック API がアップストリームで変更された場合に再度同期してください。

Getting Started から続けて

Capgo を使用している場合 スタート __CAPGO_KEEP_0__/__CAPGO_KEEP_1__を使用してファイルの保存と管理を計画し、 Using @capgo/capacitor-file Using @capgo/capacitor-file capgo/capacitor-data-storage-sqlite capgo/capacitor-data-storage-sqlite Using @capgo/capacitor-data-storage-sqlite Using @capgo/capacitor-data-storage-sqlite capgo/capacitor-file capgo/capacitor-file capgo/capacitor-uploader capgo/capacitor-uploader