Getting Started

インストール

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.

Manual Setupを使用する場合は、以下のコマンドを実行してプラットフォーム固有の指示に従ってください。

bun add @capgo/capacitor-file
bunx cap sync

インポート

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

APIの概要

requestFileSystem

__CAPGO_KEEP_0__を要求します。

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

ファイルをテキストまたはbase64で読みます。

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

await CapacitorFile.readFile({} as ReadFileOptions);

readAsDataURL

ファイルをbase64でデータURL形式で読みます (MIMEタイププレフィックス付き)。

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

await CapacitorFile.readAsDataURL({} as ReadFileOptions);

writeFile

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

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

await CapacitorFile.writeFile({} as WriteFileOptions);

appendFile

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

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

await CapacitorFile.appendFile({} as WriteFileOptions);

deleteFile

__CAPGO_KEEP_0__を削除します。

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

await CapacitorFile.deleteFile({} as DeleteFileOptions);

mkdir

__CAPGO_KEEP_0__を作成します。

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

await CapacitorFile.mkdir({} as MkdirOptions);

rmdir

__CAPGO_KEEP_0__を削除します。

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

await CapacitorFile.rmdir({} as DeleteDirectoryOptions);

readdir

__CAPGO_KEEP_0__の内容を読みます。

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

await CapacitorFile.readdir({} as ReaddirOptions);

stat

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

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

await CapacitorFile.stat({} as StatOptions);

getMetadata

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

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

await CapacitorFile.getMetadata({} as StatOptions);

rename

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

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

__CAPGO_KEEP_0__をコピーする

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

await CapacitorFile.copy({} as CopyOptions);

exists

__CAPGO_KEEP_3__が存在するかどうかを確認する

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

await CapacitorFile.exists({} as ExistsOptions);

getUri

__CAPGO_KEEP_5__を取得する

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

await CapacitorFile.getUri({} as GetUriOptions);

truncate

__CAPGO_KEEP_7__を指定したサイズに短縮する

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では常に‘許可’を返します。特殊な許可が必要ないためです。

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

await CapacitorFile.checkPermissions();

requestPermissions

コピー

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

await CapacitorFile.requestPermissions();

__CAPGO_KEEP_0__

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

Copy to clipboard

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

Copy to clipboard

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 から続けて

Capacitor を使用している場合 Getting Started から始めて Capacitor を使用してストレージとファイルの取り扱いを計画する場合は、Capacitor を接続してください。 @capgo/capacitor-file を使用して、Capacitor のネイティブ機能を使用します。 @capgo/capacitor-file を使用して、Capacitor のネイティブ機能を使用します。 @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の実装詳細