スタートガイド

インストール

AIアシストによるセットアップでプラグインをインストールできます。以下のコマンドを使用して、お使いのAIツールに Capgo のスキルを追加してください：

npx skills add https://github.com/Cap-go/capgo-skills --skill capacitor-plugins

次に、以下のプロンプトを使用します：

Use the `capacitor-plugins` skill from `Cap-go/capgo-skills` to install the `@capgo/capacitor-file` plugin in my project.

手動セットアップを希望する場合は、以下のコマンドを実行してプラグインをインストールし、下記のプラットフォーム別の手順に従ってください：

npm install @capgo/capacitor-file
npx cap sync

インポート

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

クイックスタート

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

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

例: resolveLocalFileSystemURL

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

const result = await CapacitorFile.resolveLocalFileSystemURL({
  url: 'file:///data/user/0/com.example.app/files/report.pdf',
});
console.log(result);

例: getFile

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

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

よくある落とし穴

• 権限：呼び出し checkPermissions() その後 requestPermissions() 必要に応じて。
• リスナー: 画面がアンマウントされたらハンドルを削除します。
• 信頼できる情報源: 信頼 src/definitions.ts GitHub リポジトリ内。

API の概要

requestFileSystem

ファイルシステムをリクエストします。

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

const result = await CapacitorFile.requestFileSystem({ type: FileSystemType.TEMPORARY });
console.log(result);

resolveLocalFileSystemURL

ファイルURLをエントリーに解決します。

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

const result = await CapacitorFile.resolveLocalFileSystemURL({ url: 'https://example.com' });
console.log(result);

getFile

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

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

const result = await CapacitorFile.getFile({ path: 'path/to/file' });
console.log(result);

getDirectory

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

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

const result = await CapacitorFile.getDirectory({ path: 'path/to/file' });
console.log(result);

readFile

ファイルをテキストまたはbase64として読み込みます。

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

const result = await CapacitorFile.readFile({ path: 'path/to/file' });
console.log(result);

readAsDataURL

ファイルをData URL（MIMEタイプのプレフィックス付きbase64）として読み込みます。

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

const result = await CapacitorFile.readAsDataURL({ path: 'path/to/file' });
console.log(result);

writeFile

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

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

const result = await CapacitorFile.writeFile({
  path: 'path/to/file',
  data: 'data',
});
console.log(result);

appendFile

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

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

const result = await CapacitorFile.appendFile({
  path: 'path/to/file',
  data: 'data',
});
console.log(result);

deleteFile

ファイルを削除します。

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

await CapacitorFile.deleteFile({ path: 'path/to/file' });

mkdir

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

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

await CapacitorFile.mkdir({ path: 'path/to/file' });

rmdir

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

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

await CapacitorFile.rmdir({ path: 'path/to/file' });

readdir

ディレクトリの内容を読み取ります。

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

const result = await CapacitorFile.readdir({ path: 'path/to/file' });
console.log(result);

stat

ファイルまたはディレクトリのメタデータを取得します。

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

const result = await CapacitorFile.stat({ path: 'path/to/file' });
console.log(result);

getMetadata

ファイルまたはディレクトリのメタデータを取得します。 stat() のエイリアスです。

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

const result = await CapacitorFile.getMetadata({ path: 'path/to/file' });
console.log(result);

rename

ファイルまたはディレクトリの名前を変更または移動します。

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

await CapacitorFile.rename({
  from: 'from',
  to: 'to',
});

move

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

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

await CapacitorFile.move({
  from: 'from',
  to: 'to',
});

copy

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

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

const result = await CapacitorFile.copy({
  from: 'from',
  to: 'to',
});
console.log(result);

exists

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

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

const result = await CapacitorFile.exists({ path: 'path/to/file' });
console.log(result);

getUri

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

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

const result = await CapacitorFile.getUri({ path: 'path/to/file' });
console.log(result);

truncate

ファイルを指定したサイズに切り詰めます。

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

await CapacitorFile.truncate({ path: 'path/to/file' });

getDirectories

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

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

const result = await CapacitorFile.getDirectories();
console.log(result);

getFreeDiskSpace

空きディスク容量をバイト単位で取得します。

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

const result = await CapacitorFile.getFreeDiskSpace();
console.log(result);

checkPermissions

ファイル操作の現在の権限ステータスを確認します。 Androidでは外部ストレージの権限を確認します。 iOSとWebでは、特別な権限が不要なため、常に 'granted' を返します。

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

const result = await CapacitorFile.checkPermissions();
console.log(result);

requestPermissions

ファイル操作の権限をリクエストします。 Androidでは、アプリのプライベートディレクトリ以外の ファイルにアクセスするために必要な外部ストレージ権限をリクエストします。 iOSおよびWebでは、特別な権限は不要なため、常に 'granted' を返します。

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

const result = await CapacitorFile.requestPermissions();
console.log(result);

型リファレンス

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

URLをエントリーに解決するためのオプション。

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;
}

Source of Truth

このページはプラグインの src/definitions.tsから生成されています。upstream で公開 API が変更されたら、再度 sync を実行してください。

Getting Startedの続きを進める

使用している場合 スタートガイド ストレージとファイル処理を計画するには、以下と連携してください： @capgo/capacitor-file の使い方 @capgo/capacitor-file を使用して Native Build の機能を利用する場合、 @capgo/capacitor-data-storage-sqlite @capgo/capacitor-data-storage-sqlite の実装の詳細については、 @capgo/capacitor-data-storage-sqlite の使い方 「@capgo/capacitor-data-storage-sqliteの使用方法」におけるネイティブ機能について、 @capgo/capacitor-file @capgo/capacitor-file の実装の詳細については、 @capgo/capacitor-uploader @capgo/capacitor-uploader. の実装の詳細については