Skip to main content

@rtorcato/browser-common / filesystem

filesystem

Functions​

isFileSystemApiAvailable()​

isFileSystemApiAvailable(): boolean

Defined in: filesystem/index.ts:10

Checks if the File System Access API is available in the browser.

Returns​

boolean

True if available, false otherwise.

Example​

import { isFileSystemApiAvailable } from '@rtorcato/browser-common/filesystem'
if (isFileSystemApiAvailable()) showPicker()

pickFiles()​

pickFiles(options?): Promise<File[]>

Defined in: filesystem/index.ts:49

Prompts the user to select files and returns the selected File objects.

Parameters​

options?​

OpenFilePickerOptions

File picker options.

Returns​

Promise<File[]>

The selected files.

Example​

import { pickFiles } from '@rtorcato/browser-common/filesystem'
const files = await pickFiles({ multiple: true })

saveFile()​

saveFile(options?): Promise<FileSystemWritableFileStream>

Defined in: filesystem/index.ts:68

Prompts the user to save a file and returns a writable file handle.

Parameters​

options?​

SaveFilePickerOptions

Save file picker options.

Returns​

Promise<FileSystemWritableFileStream>

The writable file stream.

Example​

import { saveFile, writeTextToFile } from '@rtorcato/browser-common/filesystem'
const stream = await saveFile({ suggestedName: 'notes.txt' })
await writeTextToFile(stream, 'hello')

readFileAsText()​

readFileAsText(file): Promise<string>

Defined in: filesystem/index.ts:87

Reads the contents of a File as text.

Parameters​

file​

File

The File object to read.

Returns​

Promise<string>

The file contents as a string.

Example​

import { readFileAsText } from '@rtorcato/browser-common/filesystem'
const text = await readFileAsText(file)

readFileAsArrayBuffer()​

readFileAsArrayBuffer(file): Promise<ArrayBuffer>

Defined in: filesystem/index.ts:101

Reads the contents of a File as an ArrayBuffer.

Parameters​

file​

File

The File object to read.

Returns​

Promise<ArrayBuffer>

The file contents as an ArrayBuffer.

Example​

import { readFileAsArrayBuffer } from '@rtorcato/browser-common/filesystem'
const buf = await readFileAsArrayBuffer(file)

writeTextToFile()​

writeTextToFile(stream, text): Promise<void>

Defined in: filesystem/index.ts:116

Writes text to a writable file stream.

Parameters​

stream​

FileSystemWritableFileStream

The writable file stream.

text​

string

The text to write.

Returns​

Promise<void>

Example​

import { writeTextToFile } from '@rtorcato/browser-common/filesystem'
await writeTextToFile(stream, 'hello world')

writeDataToFile()​

writeDataToFile(stream, data): Promise<void>

Defined in: filesystem/index.ts:135

Writes a Blob or ArrayBuffer to a writable file stream.

Parameters​

stream​

FileSystemWritableFileStream

The writable file stream.

data​

Blob | ArrayBuffer

The Blob or ArrayBuffer to write.

Returns​

Promise<void>

Example​

import { writeDataToFile } from '@rtorcato/browser-common/filesystem'
await writeDataToFile(stream, new Blob(['hi']))