Class WebFsFileHandle

Readonlytype

Staticcreate

• create(
      handle: FileSystemFileHandle,
      mode?: FileSystemPermissionMode,
  ): Promise<WebFsFileHandle | undefined>

  ファイルをWebFsFileHandleでラップしたものを返します。

  Parameters

  • handle: FileSystemFileHandle

    すでに取得しているファイルハンドル。

  • mode: FileSystemPermissionMode = "read"

    ファイルのオプション。

  Returns Promise<WebFsFileHandle | undefined>

  成功した場合はWebFsFileHandle、エラーが出た場合はundefined。

info

• info(): Promise<WebFsFileInfo>

  ファイルの情報を返します。
  これには、ファイル名、ファイルサイズ、MIMEの種類、パス、最終更新日時が含まれます。

  Returns Promise<WebFsFileInfo>

  ファイルの情報。

text

• text(): Promise<string>

  ファイルの内容をUTF-8形式の文字列として取得します。

  Returns Promise<string>

  ファイルの内容を解釈した文字列を返します。

json

• json<T = unknown>(): Promise<T | undefined>

  ファイルの内容をUTF-8形式のJSONと解釈したうえで、オブジェクトに変換して返します。

  Type Parameters

  • T = unknown

  Returns Promise<T | undefined>

  有効なJSON構文である場合はunknown、そうでない場合はundefinedが返ります。

blob

• blob(): Promise<Blob>

  ファイルをBlobとして取得します。

  Returns Promise<Blob>

  ファイルのBlobオブジェクト。

arrayBuffer

• arrayBuffer(): Promise<ArrayBuffer>

  ファイルをarrayBufferとして取得します。

  Returns Promise<ArrayBuffer>

  ファイルのarrayBufferオブジェクト。

hash

• hash(algo?: WebFsFileHashType): Promise<string>

  ファイルのハッシュ値を取得します。
  ハッシュ値のアルゴリズムは、md5、sha256、sha512から選べます。

  Parameters

  • algo: WebFsFileHashType = "sha256"

  Returns Promise<string>

  ハッシュ化された16進数の文字列。

write

• write(data: string): Promise<boolean>

  ファイルの内容をdataの内容で上書きします。

  Parameters

  • data: string

  Returns Promise<boolean>

  ファイルの書き込みに成功した場合はtrue、失敗した場合はfalse。

append

• append(data: string): Promise<boolean>

  ファイルの内容にdataの内容を追記します。

  Parameters

  • data: string

  Returns Promise<boolean>

  ファイルの書き込みに成功した場合はtrue、失敗した場合はfalse。

readStream

• readStream(): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>

  ファイルの読み込みストリームを取得します。

  Returns Promise<ReadableStream<Uint8Array<ArrayBuffer>>>

  ファイルの読み込みストリーム。

writeStream

• writeStream(
      options?: FileSystemCreateWritableOptions,
  ): Promise<FileSystemWritableFileStream>

  ファイルの書き込みストリームを取得します。

  Parameters

  • Optionaloptions: FileSystemCreateWritableOptions

  Returns Promise<FileSystemWritableFileStream>

  ファイルの書き込みストリーム。